@contentstack/cli-variants 0.0.1-alpha

package/lib/types/content-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/export-config.d.ts

@@ -0,0 +1,264 @@
+/**
+ * NOTE: Accessing ExportConfig from the export package is not possible
+ * because it will create a circular dependency and cause the prepack/build command to fail.
+ * Therefore, we are duplicating the following types from the export.
+ */
+import { AnyProperty } from './utils';
+export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps' | 'taxonomies' | 'personalization';
+export type branch = {
+    uid: string;
+    source: string;
+};
+export type masterLocale = {
+    code: string;
+};
+export interface DefaultConfig {
+    contentVersion: number;
+    versioning: boolean;
+    host: string;
+    cdn?: string;
+    developerHubUrls: any;
+    modules: {
+        types: Modules[];
+        locales: {
+            dirName: string;
+            fileName: string;
+            requiredKeys: string[];
+            dependencies?: Modules[];
+        };
+        customRoles: {
+            dirName: string;
+            fileName: string;
+            customRolesLocalesFileName: string;
+            dependencies?: Modules[];
+        };
+        'custom-roles': {
+            dirName: string;
+            fileName: string;
+            customRolesLocalesFileName: string;
+            dependencies?: Modules[];
+        };
+        environments: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        labels: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        webhooks: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        releases: {
+            dirName: string;
+            fileName: string;
+            releasesList: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        workflows: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        globalfields: {
+            dirName: string;
+            fileName: string;
+            validKeys: string[];
+            dependencies?: Modules[];
+        };
+        'global-fields': {
+            dirName: string;
+            fileName: string;
+            validKeys: string[];
+            dependencies?: Modules[];
+        };
+        assets: {
+            dirName: string;
+            fileName: string;
+            batchLimit: number;
+            host: string;
+            invalidKeys: string[];
+            chunkFileSize: number;
+            downloadLimit: number;
+            fetchConcurrency: number;
+            assetsMetaKeys: string[];
+            securedAssets: boolean;
+            displayExecutionTime: boolean;
+            enableDownloadStatus: boolean;
+            includeVersionedAssets: boolean;
+            dependencies?: Modules[];
+        };
+        content_types: {
+            dirName: string;
+            fileName: string;
+            validKeys: string[];
+            limit: number;
+            dependencies?: Modules[];
+        };
+        'content-types': {
+            dirName: string;
+            fileName: string;
+            validKeys: string[];
+            limit: number;
+            dependencies?: Modules[];
+        };
+        entries: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            batchLimit: number;
+            downloadLimit: number;
+            limit: number;
+            dependencies?: Modules[];
+            exportVersions: boolean;
+        };
+        variantEntry: {
+            dirName: string;
+            fileName: string;
+            chunkFileSize: number;
+            query: {
+                skip: number;
+                limit: number;
+                include_variant: boolean;
+                include_count: boolean;
+                include_publish_details: boolean;
+            } & AnyProperty;
+        } & AnyProperty;
+        personalization: {
+            dirName: string;
+            baseURL: Record<string, string>;
+        } & AnyProperty;
+        extensions: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        stack: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        dependency: {
+            entries: string[];
+        };
+        marketplace_apps: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        'marketplace-apps': {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        masterLocale: {
+            dirName: string;
+            fileName: string;
+            requiredKeys: string[];
+        };
+        taxonomies: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        events: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        audiences: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        attributes: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+    };
+    languagesCode: string[];
+    apis: {
+        userSession: string;
+        globalfields: string;
+        locales: string;
+        labels: string;
+        environments: string;
+        assets: string;
+        content_types: string;
+        entries: string;
+        users: string;
+        extension: string;
+        webhooks: string;
+        stacks: string;
+    };
+    preserveStackVersion: boolean;
+    fetchConcurrency: number;
+    writeConcurrency: number;
+    developerHubBaseUrl: string;
+    marketplaceAppEncryptionKey: string;
+    onlyTSModules: string[];
+}
+export interface ExportConfig extends DefaultConfig {
+    exportDir: string;
+    data: string;
+    management_token?: string;
+    apiKey: string;
+    forceStopMarketplaceAppsPrompt: boolean;
+    auth_token?: string;
+    branchName?: string;
+    securedAssets?: boolean;
+    contentTypes?: string[];
+    branches?: branch[];
+    branchEnabled?: boolean;
+    branchDir?: string;
+    singleModuleExport?: boolean;
+    moduleName?: Modules;
+    master_locale: masterLocale;
+    headers?: {
+        api_key?: string;
+        access_token?: string;
+        authtoken?: string;
+        'X-User-Agent': string;
+        organization_uid?: string;
+        'X-Project-Uid'?: string;
+    };
+    project_id?: string;
+    access_token?: string;
+    org_uid?: string;
+    source_stack?: string;
+    sourceStackName?: string;
+    personalizationEnabled: boolean;
+    personalizationHost?: string;
+    region: any;
+}
+export interface PersonalizationConfig {
+    dirName: string;
+    baseURL: Record<string, string>;
+}
+export interface EventsConfig {
+    dirName: string;
+    fileName: string;
+    invalidKeys: string[];
+}
+export interface AudiencesConfig {
+    dirName: string;
+    fileName: string;
+    invalidKeys: string[];
+}
+export interface AttributesConfig {
+    dirName: string;
+    fileName: string;
+    invalidKeys: string[];
+}

package/lib/types/export-config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/import-config.d.ts

@@ -0,0 +1,92 @@
+import { AnyProperty } from './utils';
+export interface ImportDefaultConfig extends AnyProperty {
+    modules: {
+        'content-types': {
+            dirName: string;
+            fileName: string;
+            validKeys: string[];
+            limit: number;
+        };
+        entries: {
+            dirName: string;
+            fileName: string;
+        };
+        personalization: {
+            baseURL: Record<string, string>;
+            dirName: string;
+            importData: boolean;
+            importOrder: string[];
+            project_id?: string;
+            projects: {
+                dirName: string;
+                fileName: string;
+            };
+            attributes: {
+                dirName: string;
+                fileName: string;
+            };
+            audiences: {
+                dirName: string;
+                fileName: string;
+            };
+            events: {
+                dirName: string;
+                fileName: string;
+            };
+            experiences: {
+                dirName: string;
+                fileName: string;
+                thresholdTimer: number;
+                checkIntervalDuration: number;
+            };
+        };
+        variantEntry: {
+            dirName: string;
+            fileName: string;
+            apiConcurrency: number;
+            query: {
+                locale: string;
+            } & AnyProperty;
+        } & AnyProperty;
+    } & AnyProperty;
+}
+export interface ImportConfig extends ImportDefaultConfig, AnyProperty {
+    contentDir: string;
+    data: string;
+    management_token?: string;
+    apiKey: string;
+    auth_token?: string;
+    branchName?: string;
+    branches?: branch[];
+    branchEnabled?: boolean;
+    branchDir?: string;
+    master_locale: masterLocale;
+    headers?: {
+        api_key: string;
+        access_token?: string;
+        authtoken?: string;
+        'X-User-Agent': string;
+        'X-Project-Uid'?: string;
+    };
+    access_token?: string;
+    isAuthenticated?: boolean;
+    target_stack?: string;
+    singleModuleImport?: boolean;
+    masterLocale: masterLocale;
+    backupDir: string;
+    authtoken?: string;
+    destinationStackName?: string;
+    org_uid?: string;
+    contentVersion: number;
+    replaceExisting?: boolean;
+    skipExisting?: boolean;
+    stackName?: string;
+}
+type branch = {
+    uid: string;
+    source: string;
+};
+type masterLocale = {
+    code: string;
+};
+export {};

package/lib/types/import-config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from './utils';
+export * from './export-config';
+export * from './import-config';
+export * from './variant-entry';
+export * from './content-types';
+export * from './adapter-helper';
+export * from './variant-api-adapter';
+export * from './personalization-api-adapter';

package/lib/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./utils"), exports);
+__exportStar(require("./export-config"), exports);
+__exportStar(require("./import-config"), exports);
+__exportStar(require("./variant-entry"), exports);
+__exportStar(require("./content-types"), exports);
+__exportStar(require("./adapter-helper"), exports);
+__exportStar(require("./variant-api-adapter"), exports);
+__exportStar(require("./personalization-api-adapter"), exports);

package/lib/types/personalization-api-adapter.d.ts

@@ -0,0 +1,152 @@
+import { HttpClient } from '@contentstack/cli-utilities';
+import { AnyProperty } from './utils';
+import { AdapterHelperInterface } from './adapter-helper';
+export type ProjectStruct = {
+    _id: string;
+    uid: string;
+    name: string;
+    description: string;
+    audienceCount: number;
+    organizationUid: string;
+    activeExperienceCount: number;
+} & AnyProperty;
+export type GetProjectsParams = {
+    connectedStackApiKey: string;
+    includeAudienceCount?: boolean;
+    includeActiveExperienceCount?: boolean;
+    callback?: (value: ProjectStruct[]) => void;
+} & AnyProperty;
+export interface CreateProjectInput {
+    name: string;
+    description: string;
+    connectedStackApiKey?: string;
+}
+export type GetVariantGroupInput = {
+    experienceUid: string;
+};
+export type VariantGroup = {
+    uid: string;
+    name: string;
+    content_types: string[];
+    description: string;
+} & AnyProperty;
+export type VariantGroupStruct = {
+    variant_groups: Array<VariantGroup>;
+} & AnyProperty;
+export type EventStruct = {
+    _id: string;
+    uid: string;
+    key: string;
+    name: string;
+    description: string;
+    project: string;
+} & AnyProperty;
+export type AudienceStruct = {
+    _id: string;
+    uid: string;
+    definition: {
+        _type: string;
+        combinationType: string;
+        rules: Record<string, any>[];
+    };
+    name: string;
+    description: string;
+    project: string;
+} & AnyProperty;
+export type AttributeStruct = {
+    _id: string;
+    uid: string;
+    key: string;
+    name: string;
+    project: string;
+    description: string;
+} & AnyProperty;
+export interface CreateAttributeInput {
+    name: string;
+    key: string;
+    description: string;
+}
+export interface CreateEventInput {
+    key: string;
+    description: string;
+}
+export interface CreateAudienceInput {
+    name: string;
+    definition: object;
+    description: string;
+}
+type ExpVariations = {
+    name: string;
+    __type: string;
+    audiences?: string[];
+    audienceCombinationType?: string;
+    shortUid?: string;
+    trafficDistribution?: string;
+} & AnyProperty;
+type ExpTargeting = {
+    audience?: {
+        audiences?: string[];
+        audienceCombinationType?: string;
+    } & AnyProperty;
+};
+export type ExpMetric = {
+    event: string;
+    name: string;
+    __type: string;
+} & AnyProperty;
+export type ExperienceStruct = {
+    _id: string;
+    uid: string;
+    name: string;
+    __type: string;
+    description: string;
+    targeting?: ExpTargeting;
+    variations: ExpVariations[];
+    variationSplit?: string;
+    metrics?: ExpMetric[];
+    status: string;
+    metadata?: object;
+    _cms?: {
+        variantGroup: object;
+        variants: Record<string, string>;
+    };
+    content_types?: string[];
+} & AnyProperty;
+export interface CreateExperienceInput {
+    name: string;
+    __type: string;
+    description: string;
+    targeting?: ExpTargeting;
+    variations: ExpVariations[];
+    variationSplit?: string;
+    metrics?: ExpMetric[];
+    status: string;
+    metadata?: object;
+}
+export interface UpdateExperienceInput {
+    contentTypes: string[];
+}
+export interface CMSExperienceStruct {
+    uid: string;
+    contentTypes: string[];
+    content_types?: string[];
+}
+export type VariantAPIRes = ProjectStruct[] | ProjectStruct | AttributeStruct[] | AttributeStruct | ExperienceStruct[] | EventStruct[] | AudienceStruct[] | ExperienceStruct | EventStruct | AudienceStruct | CMSExperienceStruct | VariantGroupStruct | Error;
+export interface APIResponse {
+    status: number;
+    data: any;
+}
+export interface Personalization<T> extends AdapterHelperInterface<T, HttpClient> {
+    projects(options: GetProjectsParams): Promise<ProjectStruct[] | void>;
+    createProject(project: CreateProjectInput): Promise<ProjectStruct | void>;
+    getEvents(): Promise<EventStruct[] | void>;
+    getAudiences(): Promise<AudienceStruct[] | void>;
+    getAttributes(): Promise<AttributeStruct[] | void>;
+    createAttribute(attribute: CreateAttributeInput): Promise<AttributeStruct | void>;
+    createAudience(attribute: CreateAudienceInput): Promise<AudienceStruct | void>;
+    createExperience(experience: CreateExperienceInput): Promise<ExperienceStruct | void>;
+    getCTsFromExperience(experienceUid: string): Promise<CMSExperienceStruct | void>;
+    updateCTsInExperience(experience: UpdateExperienceInput, experienceUid: string): Promise<CMSExperienceStruct | void>;
+    handleVariantAPIRes(res: any): VariantAPIRes;
+}
+export {};

package/lib/types/personalization-api-adapter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/utils.d.ts

@@ -0,0 +1,7 @@
+export interface AnyProperty {
+    [propName: string]: any;
+}
+export interface LogType {
+    (message: any): void;
+    (config: any, message: any, type: 'info' | 'error' | 'success'): void;
+}

package/lib/types/utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/variant-api-adapter.d.ts

@@ -0,0 +1,49 @@
+import { HttpClientOptions, HttpRequestConfig } from '@contentstack/cli-utilities';
+import { APIResponse } from '../types';
+import { AnyProperty } from './utils';
+import { ExportConfig } from './export-config';
+import { AdapterHelperInterface } from './adapter-helper';
+import { CreateVariantEntryDto, CreateVariantEntryOptions, VariantEntryStruct } from './variant-entry';
+export type APIConfig = HttpRequestConfig & {
+    httpClient?: boolean;
+    sharedConfig?: ExportConfig | Record<string, any> | undefined;
+    personalizationURL?: string;
+    config: ExportConfig | Record<string, any> | undefined;
+    baseURL?: string;
+    cmaConfig?: HttpRequestConfig;
+};
+export interface AdapterConstructor<T, C> {
+    new (config: C, options?: HttpClientOptions): T;
+}
+export type AdapterType<T, C> = {
+    Adapter: AdapterConstructor<T, C>;
+};
+export type VariantsOption = {
+    skip?: number;
+    limit?: number;
+    locale?: string;
+    entry_uid: string;
+    getAllData?: boolean;
+    returnResult?: boolean;
+    content_type_uid: string;
+    include_variant?: boolean;
+    include_count?: boolean;
+    include_publish_details?: boolean;
+    callback?: (value: Record<string, any>[]) => void;
+} & AnyProperty;
+export type VariantOptions = VariantsOption & {
+    variant_uid: string;
+};
+export interface VariantInterface<T, ApiClient> extends AdapterHelperInterface<T, ApiClient> {
+    variantEntry(options: VariantOptions): Promise<{
+        entry: Record<string, any>;
+    }>;
+    variantEntries(options: VariantsOption): Promise<{
+        entries?: Record<string, any>[] | unknown[];
+    } | void>;
+    createVariantEntry(input: CreateVariantEntryDto, options: CreateVariantEntryOptions, apiParams: Record<string, any>): Promise<VariantEntryStruct | string | void>;
+    handleVariantAPIRes(res: APIResponse): VariantEntryStruct | {
+        entries: VariantEntryStruct[];
+        count: number;
+    } | string;
+}

package/lib/types/variant-api-adapter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/variant-entry.d.ts

@@ -0,0 +1,47 @@
+import { AnyProperty } from './utils';
+export type VariantEntryStruct = {
+    uid: string;
+    title: string;
+    variant_id: string;
+    locale: string;
+    _version: number;
+    _variant: {
+        uid: string;
+        _change_set: string[];
+        _base_entry_version: number;
+    };
+    publish_details: Record<string, any>[];
+} & AnyProperty;
+export type EntryDataForVariantEntries = {
+    content_type: string;
+    locale: string;
+    entry_uid: string;
+};
+export type CreateVariantEntryDto = {
+    _variant: {
+        _change_set: string[];
+    };
+} & AnyProperty;
+export type CreateVariantEntryOptions = {
+    locale?: string;
+    entry_uid: string;
+    variant_id: string;
+    content_type_uid: string;
+};
+export type PublishVariantEntryOptions = {
+    entry_uid: string;
+    content_type_uid: string;
+};
+export type PublishVariantEntryDto = {
+    entry: {
+        environments: string[];
+        locales: string[];
+        publish_with_base_entry: boolean;
+        variants: {
+            uid: string;
+            version?: number;
+        }[];
+    };
+    locale: string;
+    version?: number;
+} & AnyProperty;

package/lib/types/variant-entry.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });