@tomlahav/cms-sdk v0.0.9

Instructions

1. SDKClient.getInstance() gets the singleton instance
2. client must be initalized before use with following values:
   1. LD_AUTH_TOKEN=auth token from LD for API
   2. LD_PROJECT_ID=project within LD to interact with
   3. LD_ENV=Launchdarkly environment name

Main ways of using

1. client.init(config: IConfig) =>
   1. Initalizes SDK with LaunchDarkly auth and environment values
2. client.getValueOrCreate(contentNamespace, contentKey) =>
   1. If combination of namespace and key exist, this will return the value stored
   2. If combination of namespace and key does NOT exist, SDK will create a stub in service with placeholder text and return placeholder value
3. client.getValue(contentNamespace, contentKey) =>
   1. returns a single value by namespace and key but does NOT create missing entries

Other available methods for devs

1. getFlagValue(contentNamespace)
   1. gets raw value from Variation 1 of a specific flag
2. updateContentEntry(data: IUpdateContent)
   1. Updates/Overwrites a variation
3. createContentEntry(dto: ICreateContentEntryDTO)
   1. Creates a new Flag in LaunchDarkly with an Optional Content or default placeholder text
4. deleteContentEntry(contentNamespace: string)
   1. Deletes a LaunchDarkly flag by Key

Interfaces:

export interface IConfig {
    LD_AUTH_TOKEN: string,
    LD_PROJECT_ID: string,
    LD_ENV: string
}

export interface ICreateContentEntryDTO {
    contentNamespace: string,
    contentKey: string,
    contentName?: string,
    contentValue?: string
}

export interface IUpdateContent {
    contentNamespace: string,
    newValue: json
    variation?: number,
}