Skip to content

Type-safety for the Gigya / SAP Customer Data Cloud REST API & Web SDK

License

Notifications You must be signed in to change notification settings

tswymer/gigya-ts

Repository files navigation

@gigya-ts - Type-Safe Gigya / SAP Customer Data Cloud

SAP Customer Data Cloud, formally known as Gigya, does not provide official TypeScript type definitions. This project aims to adds those missing definitions to your SAP Customer Data Cloud implementation, providing type-safety and code completion in your IDE for both the Gigya REST API and Gigya Web SDK. These definitions are taken from the official APIs and SDKs documentation.

As the SAP Customer Data Cloud APIs still use the gigya namespace, this project also adopts that name. This project is fully compatible with SAP Customer Data Cloud.

This is an unofficial project and is not supported by SAP nor any other party. Use at your own risk.

Motivation

  • Add strong typings SAP Customer Data Cloud projects, including support for custom schemas (data, preferences, subscriptions).
  • Expose a minimal, promise-based client to interface with the Gigya REST API, supporting both Node.js and the browser (see @gigya-ts/gigya).
  • Add type-safety to projects using the Gigya Web SDK (see @gigya-ts/web-sdk) in the browser.
  • Share the same type definitions across all packages, ensuring full-stack consistency.
  • Tiny bundle sizes, almost everything is just type definitions (see @gigya-ts/rest-api).
  • No external dependencies.

Repository Structure

This repository contains multiple related projects, each of which provide their own features and documentation. Please refer to each of the projects for more information on installation and usage:

A minimal type-safe client for interacting with the Gigya REST API for Node.js and the browser.

Adds type-safety to Gigya Web SDK projects in the browser.

Type definitions for the Gigya REST API, providing the base type definitions for all other packages in this repository. You probably don't need to use this package yourself in your project.

About

Type-safety for the Gigya / SAP Customer Data Cloud REST API & Web SDK

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •