@croct/sdk 0.10.0 → 0.11.0-alpha.1

package/.src/schema/ecommerceSchemas.ts

@@ -0,0 +1,179 @@
+import {ObjectType, StringType, NumberType, ArrayType} from '../validation';
+
+export const productDetails = new ObjectType({
+    required: ['productId', 'name', 'displayPrice'],
+    properties: {
+        productId: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        sku: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        name: new StringType({
+            minLength: 1,
+            maxLength: 200,
+        }),
+        category: new StringType({
+            minLength: 1,
+            maxLength: 100,
+        }),
+        brand: new StringType({
+            minLength: 1,
+            maxLength: 100,
+        }),
+        variant: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        displayPrice: new NumberType({
+            minimum: 0,
+        }),
+        originalPrice: new NumberType({
+            minimum: 0,
+        }),
+        url: new StringType({
+            format: 'url',
+        }),
+        imageUrl: new StringType({
+            format: 'url',
+        }),
+    },
+});
+
+export const cartItem = new ObjectType({
+    required: ['index', 'product', 'quantity', 'total'],
+    properties: {
+        index: new NumberType({
+            minimum: 0,
+        }),
+        product: productDetails,
+        quantity: new NumberType({
+            minimum: 1,
+        }),
+        total: new NumberType({
+            minimum: 0,
+        }),
+        discount: new NumberType({
+            minimum: 0,
+        }),
+        coupon: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+    },
+});
+
+export const cart = new ObjectType({
+    required: ['currency', 'items', 'total'],
+    properties: {
+        currency: new StringType({
+            maxLength: 10,
+            minLength: 1,
+        }),
+        items: new ArrayType({
+            items: cartItem,
+        }),
+        subtotal: new NumberType({
+            minimum: 0,
+        }),
+        shippingPrice: new NumberType({
+            minimum: 0,
+        }),
+        taxes: new ObjectType({
+            additionalProperties: new NumberType(),
+            minProperties: 1,
+        }),
+        costs: new ObjectType({
+            additionalProperties: new NumberType(),
+            minProperties: 1,
+        }),
+        discount: new NumberType({
+            minimum: 0,
+        }),
+        total: new NumberType({
+            minimum: 0,
+        }),
+        coupon: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        lastUpdateTime: new NumberType(),
+    },
+});
+
+export const orderItem = new ObjectType({
+    required: ['index', 'product', 'quantity', 'total'],
+    properties: {
+        index: new NumberType({
+            minimum: 0,
+        }),
+        product: productDetails,
+        quantity: new NumberType({
+            minimum: 1,
+        }),
+        total: new NumberType({
+            minimum: 0,
+        }),
+        discount: new NumberType({
+            minimum: 0,
+        }),
+        coupon: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+    },
+});
+
+export const order = new ObjectType({
+    required: ['orderId', 'currency', 'items', 'total'],
+    properties: {
+        orderId: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        currency: new StringType({
+            maxLength: 10,
+            minLength: 1,
+        }),
+        items: new ArrayType({
+            items: orderItem,
+            minItems: 1,
+        }),
+        subtotal: new NumberType({
+            minimum: 0,
+        }),
+        shippingPrice: new NumberType({
+            minimum: 0,
+        }),
+        taxes: new ObjectType({
+            additionalProperties: new NumberType(),
+            minProperties: 1,
+        }),
+        costs: new ObjectType({
+            additionalProperties: new NumberType(),
+            minProperties: 1,
+        }),
+        discount: new NumberType({
+            minimum: 0,
+        }),
+        total: new NumberType({
+            minimum: 0,
+        }),
+        coupon: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        paymentMethod: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        installments: new NumberType({
+            minimum: 1,
+        }),
+        status: new StringType({
+            enumeration: ['placed', 'paid', 'complete'],
+        }),
+    },
+});

package/.src/schema/evaluatorSchemas.ts

@@ -0,0 +1,11 @@
+import {ObjectType, NumberType, JsonObjectType} from '../validation';
+
+export const evaluationOptionsSchema = new ObjectType({
+    properties: {
+        timeout: new NumberType({
+            integer: true,
+            minimum: 0,
+        }),
+        attributes: new JsonObjectType(),
+    },
+});

package/.src/schema/eventSchemas.ts

@@ -0,0 +1,150 @@
+import {
+    ObjectType,
+    StringType,
+    NumberType,
+    UnionType,
+    NullType,
+    BooleanType,
+    ArrayType,
+} from '../validation';
+import {cart, order, productDetails} from './ecommerceSchemas';
+import {userProfileSchema} from './userSchema';
+import {postDetails} from './contentSchemas';
+
+export const cartModified = new ObjectType({
+    required: ['cart'],
+    properties: {
+        cart: cart,
+    },
+});
+
+export const cartViewed = new ObjectType({
+    required: ['cart'],
+    properties: {
+        cart: cart,
+    },
+});
+
+export const checkoutStarted = new ObjectType({
+    required: ['cart'],
+    properties: {
+        cart: cart,
+        orderId: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+    },
+});
+
+export const orderPlaced = new ObjectType({
+    required: ['order'],
+    properties: {
+        order: order,
+    },
+});
+
+export const productViewed = new ObjectType({
+    required: ['product'],
+    properties: {
+        product: productDetails,
+    },
+});
+
+export const userSignedUp = new ObjectType({
+    required: ['userId'],
+    properties: {
+        userId: new StringType({
+            minLength: 1,
+            maxLength: 254,
+        }),
+        profile: userProfileSchema,
+    },
+});
+
+export const goalCompleted = new ObjectType({
+    required: ['goalId'],
+    properties: {
+        goalId: new StringType({
+            minLength: 3,
+            maxLength: 100,
+            pattern: /^[a-z0-9][a-z0-9:_-]+[a-z0-9]$/i,
+        }),
+        value: new NumberType({
+            minimum: 0,
+        }),
+        currency: new StringType({
+            minLength: 1,
+            maxLength: 10,
+        }),
+    },
+});
+
+export const interestShown = new ObjectType({
+    required: ['interests'],
+    properties: {
+        interests: new ArrayType({
+            items: new StringType({
+                minLength: 1,
+                maxLength: 50,
+            }),
+            minItems: 1,
+            maxItems: 10,
+        }),
+    },
+});
+
+export const postViewed = new ObjectType({
+    required: ['post'],
+    properties: {
+        post: postDetails,
+    },
+});
+
+export const linkOpened = new ObjectType({
+    required: ['link'],
+    properties: {
+        link: new StringType(),
+    },
+});
+
+export const eventOccurred = new ObjectType({
+    required: ['name'],
+    properties: {
+        name: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        testId: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        groupId: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        personalizationId: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        audience: new StringType({
+            minLength: 1,
+            maxLength: 50,
+        }),
+        details: new ObjectType({
+            additionalProperties: new UnionType(
+                new NullType(),
+                new BooleanType(),
+                new NumberType(),
+                new StringType({
+                    maxLength: 300,
+                }),
+            ),
+            propertyNames: new StringType({
+                minLength: 1,
+                maxLength: 20,
+                format: 'identifier',
+            }),
+            maxProperties: 10,
+        }),
+    },
+});

package/.src/schema/index.ts

@@ -0,0 +1,11 @@
+export * from './contextSchemas';
+export * from './ecommerceSchemas';
+export * from './evaluatorSchemas';
+export * from './contentFetcherSchemas';
+export * from './eventSchemas';
+export * from './loggerSchema';
+export * from './operationSchemas';
+export * from './sdkFacadeSchemas';
+export * from './sdkSchemas';
+export * from './tokenSchema';
+export * from './userSchema';

package/.src/schema/loggerSchema.ts

@@ -0,0 +1,12 @@
+import {ObjectType, FunctionType} from '../validation';
+
+export const loggerSchema = new ObjectType({
+    required: ['debug', 'info', 'warn', 'error'],
+    additionalProperties: true,
+    properties: {
+        debug: new FunctionType(),
+        info: new FunctionType(),
+        warn: new FunctionType(),
+        error: new FunctionType(),
+    },
+});

package/.src/schema/operationSchemas.ts

@@ -0,0 +1,102 @@
+import {
+    ObjectType,
+    StringType,
+    NumberType,
+    JsonArrayType,
+    JsonObjectType,
+    JsonPrimitiveType,
+    UnionType,
+} from '../validation';
+import {attributeNameSchema} from './attributeSchema';
+
+const pointer = new StringType({
+    format: 'pointer',
+});
+
+const simpleArray = new JsonArrayType({
+    items: new JsonPrimitiveType(),
+});
+
+const simpleMap = new JsonObjectType({
+    properties: new JsonPrimitiveType(),
+    propertyNames: attributeNameSchema,
+});
+
+const complexMap = new JsonObjectType({
+    properties: new UnionType(new JsonPrimitiveType(), simpleArray, simpleMap),
+    propertyNames: attributeNameSchema,
+});
+
+const collectionValue = new UnionType(simpleArray, complexMap);
+
+const mixedValue = new UnionType(new JsonPrimitiveType(), simpleArray, complexMap);
+
+export const addOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: mixedValue,
+    },
+});
+
+export const setOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: mixedValue,
+    },
+});
+
+export const combineOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: mixedValue,
+    },
+});
+
+export const mergeOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: collectionValue,
+    },
+});
+
+export const decrementOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: new NumberType(),
+    },
+});
+
+export const incrementOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: new NumberType(),
+    },
+});
+
+export const clearOperation = new ObjectType({
+    required: ['path'],
+    properties: {
+        path: pointer,
+    },
+});
+
+export const unsetOperation = new ObjectType({
+    required: ['path'],
+    properties: {
+        path: pointer,
+    },
+});
+
+export const removeOperation = new ObjectType({
+    required: ['path', 'value'],
+    properties: {
+        path: pointer,
+        value: mixedValue,
+    },
+});

package/.src/schema/sdkFacadeSchemas.ts

@@ -0,0 +1,44 @@
+import {ObjectType, StringType, BooleanType, UnionType, NullType, FunctionType} from '../validation';
+import {tokenScopeSchema} from './contextSchemas';
+import {eventMetadataSchema} from './sdkSchemas';
+import {loggerSchema} from './loggerSchema';
+
+export const sdkFacadeConfigurationSchema = new ObjectType({
+    required: ['appId'],
+    properties: {
+        appId: new StringType({
+            format: 'uuid',
+        }),
+        clientId: new StringType({
+            pattern: /^[0-9a-f]{32}$/i,
+        }),
+        tokenScope: tokenScopeSchema,
+        debug: new BooleanType(),
+        test: new BooleanType(),
+        track: new BooleanType(),
+        logger: loggerSchema,
+        urlSanitizer: new FunctionType(),
+        eventMetadata: eventMetadataSchema,
+        userId: new StringType({
+            minLength: 1,
+        }),
+        token: new UnionType(
+            new StringType({
+                pattern: /^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9-_.+/=]*$/,
+            }),
+            new NullType(),
+        ),
+        trackerEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        evaluationEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        contentEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        cidAssignerEndpointUrl: new StringType({
+            format: 'url',
+        }),
+    },
+});

package/.src/schema/sdkSchemas.ts

@@ -0,0 +1,49 @@
+import {ObjectType, StringType, BooleanType, NumberType, FunctionType} from '../validation';
+import {tokenScopeSchema} from './contextSchemas';
+import {loggerSchema} from './loggerSchema';
+
+export const eventMetadataSchema = new ObjectType({
+    maxProperties: 5,
+    propertyNames: new StringType({
+        minLength: 1,
+        maxLength: 20,
+        format: 'identifier',
+    }),
+    additionalProperties: new StringType({
+        maxLength: 300,
+    }),
+});
+
+export const sdkConfigurationSchema = new ObjectType({
+    required: ['appId'],
+    properties: {
+        appId: new StringType({
+            format: 'uuid',
+        }),
+        clientId: new StringType({
+            pattern: /^[0-9a-f]{32}$/i,
+        }),
+        tokenScope: tokenScopeSchema,
+        trackerEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        evaluationEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        contentEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        cidAssignerEndpointUrl: new StringType({
+            format: 'url',
+        }),
+        beaconQueueSize: new NumberType({
+            minimum: 0,
+            integer: true,
+        }),
+        debug: new BooleanType(),
+        test: new BooleanType(),
+        logger: loggerSchema,
+        urlSanitizer: new FunctionType(),
+        eventMetadata: eventMetadataSchema,
+    },
+});

package/.src/schema/tokenSchema.ts

@@ -0,0 +1,42 @@
+import {ObjectType, StringType, NumberType, UnionType, ArrayType} from '../validation';
+
+export const tokenSchema = new ObjectType({
+    required: ['headers', 'payload'],
+    properties: {
+        headers: new ObjectType({
+            required: ['typ', 'alg'],
+            properties: {
+                typ: new StringType(),
+                alg: new StringType(),
+                kid: new StringType(),
+                appId: new StringType({
+                    format: 'uuid',
+                }),
+            },
+        }),
+        payload: new ObjectType({
+            required: ['iss', 'aud', 'iat'],
+            properties: {
+                iss: new StringType(),
+                aud: new UnionType(
+                    new StringType(),
+                    new ArrayType({items: new StringType()}),
+                ),
+                iat: new NumberType({
+                    minimum: 0,
+                }),
+                sub: new StringType({
+                    minLength: 1,
+                }),
+                exp: new NumberType({
+                    minimum: 0,
+                }),
+                jti: new StringType({
+                    format: 'uuid',
+                }),
+            },
+            additionalProperties: true,
+        }),
+        signature: new StringType(),
+    },
+});