@salesforce/lds-adapters-community-microbatching 1.100.2

package/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@salesforce/lds-adapters-community-microbatching",
+    "version": "1.100.2",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "Microbatching requests",
+    "main": "dist/umd/es2018/community-microbatching.js",
+    "module": "dist/es/es2018/community-microbatching.js",
+    "types": "dist/types/src/generated/artifacts/main.d.ts",
+    "files": [
+        "dist",
+        "sfdc",
+        "src/raml/*"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/es/es2018/community-microbatching.js",
+            "require": "./dist/umd/es2018/community-microbatching.js",
+            "types": "./dist/types/src/generated/artifacts/main.d.ts"
+        },
+        "./sfdc": {
+            "import": "./sfdc/index.js",
+            "types": "./sfdc/index.d.ts",
+            "default": "./sfdc/index.js"
+        }
+    },
+    "contributors": [
+        "pmaliwat@salesforce.com"
+    ],
+    "scripts": {
+        "build": "yarn build:raml && yarn build:services && yarn build:karma",
+        "build:karma": "rollup --config rollup.config.karma.js",
+        "build:raml": "luvio generate src/raml/luvio.raml src/generated -p '../lds-compiler-plugins'",
+        "build:services": "rollup --config rollup.config.js",
+        "clean": "rm -rf dist sfdc src/generated karma/dist",
+        "release:core": "../../scripts/release/core.js --adapter=lds-adapters-community-microbatching",
+        "release:corejar": "yarn build && packages/core-build/scripts/core.js --adapter=lds-adapters-community-microbatching",
+        "start": "karma start",
+        "test": "karma start --single-run",
+        "test:compat": "karma start --single-run --compat"
+    },
+    "dependencies": {
+        "@salesforce/lds-bindings": "^1.100.2"
+    },
+    "devDependencies": {
+        "@luvio/cli": "0.135.4",
+        "@luvio/compiler": "0.135.4",
+        "@luvio/engine": "0.135.4",
+        "@luvio/lwc-luvio": "0.135.4",
+        "@salesforce/lds-karma": "^1.100.2"
+    },
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "packages/lds-adapters-community-microbatching/dist",
+                    "packages/lds-adapters-community-microbatching/karma/dist",
+                    "packages/lds-adapters-community-microbatching/sfdc",
+                    "packages/lds-adapters-community-microbatching/src/generated"
+                ]
+            }
+        }
+    },
+    "volta": {
+        "extends": "../../package.json"
+    }
+}

package/sfdc/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/types/src/generated/artifacts/sfdc';

package/sfdc/index.js

@@ -0,0 +1,337 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/*  *******************************************************************************************
+ *  ATTENTION!
+ *  THIS IS A GENERATED FILE FROM https://github.com/salesforce-experience-platform-emu/lds-lightning-platform
+ *  If you would like to contribute to LDS, please follow the steps outlined in the git repo.
+ *  Any changes made to this file in p4 will be automatically overwritten.
+ *  *******************************************************************************************
+ */
+/* proxy-compat-disable */
+import { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, StoreKeyMap } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys$1, freeze: ObjectFreeze$1, create: ObjectCreate$1 } = Object;
+const { isArray: ArrayIsArray$1 } = Array;
+/**
+ * Validates an adapter config is well-formed.
+ * @param config The config to validate.
+ * @param adapter The adapter validation configuration.
+ * @param oneOf The keys the config must contain at least one of.
+ * @throws A TypeError if config doesn't satisfy the adapter's config validation.
+ */
+function validateConfig(config, adapter, oneOf) {
+    const { displayName } = adapter;
+    const { required, optional, unsupported } = adapter.parameters;
+    if (config === undefined ||
+        required.every(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify ${required.sort().join(', ')}`);
+    }
+    if (oneOf && oneOf.some(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify one of ${oneOf.sort().join(', ')}`);
+    }
+    if (unsupported !== undefined &&
+        unsupported.some(req => ObjectPrototypeHasOwnProperty.call(config, req))) {
+        throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
+    }
+    const supported = required.concat(optional);
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
+        throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
+    }
+}
+function untrustedIsObject(untrusted) {
+    return typeof untrusted === 'object' && untrusted !== null && ArrayIsArray$1(untrusted) === false;
+}
+function areRequiredParametersPresent(config, configPropertyNames) {
+    return configPropertyNames.parameters.required.every(req => req in config);
+}
+const keyPrefix = 'microbatching';
+
+const { freeze: ObjectFreeze, keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
+const { isArray: ArrayIsArray } = Array;
+function deepFreeze(value) {
+    // No need to freeze primitives
+    if (typeof value !== 'object' || value === null) {
+        return;
+    }
+    if (ArrayIsArray(value)) {
+        for (let i = 0, len = value.length; i < len; i += 1) {
+            deepFreeze(value[i]);
+        }
+    }
+    else {
+        const keys = ObjectKeys(value);
+        for (let i = 0, len = keys.length; i < len; i += 1) {
+            deepFreeze(value[keys[i]]);
+        }
+    }
+    ObjectFreeze(value);
+}
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+function validate$1(obj, path = 'MicrobatchingIngestionInputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        if (obj.groupBy !== undefined) {
+            const obj_groupBy = obj.groupBy;
+            const path_groupBy = path + '.groupBy';
+            if (typeof obj_groupBy !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_groupBy + '" (at "' + path_groupBy + '")');
+            }
+        }
+        if (obj.keyPrefix !== undefined) {
+            const obj_keyPrefix = obj.keyPrefix;
+            const path_keyPrefix = path + '.keyPrefix';
+            if (typeof obj_keyPrefix !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_keyPrefix + '" (at "' + path_keyPrefix + '")');
+            }
+        }
+        const obj_processType = obj.processType;
+        const path_processType = path + '.processType';
+        if (typeof obj_processType !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_processType + '" (at "' + path_processType + '")');
+        }
+        const obj_requestBody = obj.requestBody;
+        const path_requestBody = path + '.requestBody';
+        if (typeof obj_requestBody !== 'object' || ArrayIsArray(obj_requestBody) || obj_requestBody === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj_requestBody + '" (at "' + path_requestBody + '")');
+        }
+        const obj_requestBody_keys = ObjectKeys(obj_requestBody);
+        for (let i = 0; i < obj_requestBody_keys.length; i++) {
+            const key = obj_requestBody_keys[i];
+            const obj_requestBody_prop = obj_requestBody[key];
+            const path_requestBody_prop = path_requestBody + '["' + key + '"]';
+            if (obj_requestBody_prop === undefined) {
+                return new TypeError('Expected "defined" but received "' + typeof obj_requestBody_prop + '" (at "' + path_requestBody_prop + '")');
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+const TTL = 100;
+const VERSION = "d9a668888b418883dcdd91e33b218549";
+function validate(obj, path = 'MicrobatchingIngestionOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_recordUUID = obj.recordUUID;
+        const path_recordUUID = path + '.recordUUID';
+        if (typeof obj_recordUUID !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_recordUUID + '" (at "' + path_recordUUID + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'MicrobatchingIngestionOutputRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.recordUUID;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        recordUUID: object.recordUUID
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function MicrobatchingIngestionOutputRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'recordUUID',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_recordUUID = existing.recordUUID;
+    const incoming_recordUUID = incoming.recordUUID;
+    if (!(existing_recordUUID === incoming_recordUUID)) {
+        return false;
+    }
+    return true;
+}
+const ingest = function MicrobatchingIngestionOutputRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = keyBuilderFromType(luvio, input);
+    const existingRecord = store.readEntry(key);
+    const ttlToUse = TTL;
+    let incomingRecord = normalize(input, store.readEntry(key), {
+        fullPath: key,
+        parent: path.parent,
+        propertyName: path.propertyName,
+        ttl: ttlToUse
+    });
+    if (existingRecord === undefined || equals(existingRecord, incomingRecord) === false) {
+        luvio.storePublish(key, incomingRecord);
+    }
+    {
+        const storeMetadataParams = {
+            ttl: ttlToUse,
+            namespace: "microbatching",
+            version: VERSION,
+            representationName: RepresentationType,
+        };
+        luvio.publishStoreMetadata(key, storeMetadataParams);
+    }
+    return createLink(key);
+};
+function getTypeCacheKeys(luvio, input, fullPathFactory) {
+    const rootKeySet = new StoreKeyMap();
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = keyBuilderFromType(luvio, input);
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+    return rootKeySet;
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function getResponseCacheKeys(luvio, resourceParams, response) {
+    return getTypeCacheKeys(luvio, response);
+}
+function ingestSuccess(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType(luvio, body);
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select(),
+        variables: {},
+    });
+    if (process.env.NODE_ENV !== 'production') {
+        if (snapshot.state !== 'Fulfilled') {
+            throw new Error('Invalid network response. Expected resource response to result in Fulfilled snapshot');
+        }
+    }
+    return snapshot;
+}
+function createResourceRequest(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v58.0',
+        basePath: '/connect/communities/' + config.urlParams.communityId + '/microbatching',
+        method: 'post',
+        body: config.body,
+        urlParams: config.urlParams,
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const ingestRecord_ConfigPropertyNames = {
+    displayName: 'ingestRecord',
+    parameters: {
+        required: ['communityId', 'requestIngestionInput'],
+        optional: []
+    }
+};
+function createResourceParams(config) {
+    const resourceParams = {
+        urlParams: {
+            communityId: config.communityId
+        },
+        body: {
+            requestIngestionInput: config.requestIngestionInput
+        }
+    };
+    return resourceParams;
+}
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    const untrustedConfig_communityId = untrustedConfig.communityId;
+    if (typeof untrustedConfig_communityId === 'string') {
+        config.communityId = untrustedConfig_communityId;
+    }
+    const untrustedConfig_requestIngestionInput = untrustedConfig.requestIngestionInput;
+    const referenceMicrobatchingIngestionInputRepresentationValidationError = validate$1(untrustedConfig_requestIngestionInput);
+    if (referenceMicrobatchingIngestionInputRepresentationValidationError === null) {
+        config.requestIngestionInput = untrustedConfig_requestIngestionInput;
+    }
+    return config;
+}
+function validateAdapterConfig(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function buildNetworkSnapshot(luvio, config, options) {
+    const resourceParams = createResourceParams(config);
+    const request = createResourceRequest(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => getResponseCacheKeys(luvio, resourceParams, response.body));
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const ingestRecordAdapterFactory = (luvio) => {
+    return function ingestRecord(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, ingestRecord_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "ingestRecord"');
+        }
+        return buildNetworkSnapshot(luvio, config);
+    };
+};
+
+let ingestRecord;
+function bindExportsTo(luvio) {
+    function unwrapSnapshotData(factory) {
+        const adapter = factory(luvio);
+        return (config) => adapter(config).then(snapshot => snapshot.data);
+    }
+    return {
+        ingestRecord: unwrapSnapshotData(ingestRecordAdapterFactory),
+        // Imperative GET Adapters
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({
+        ingestRecord,
+    } = bindExportsTo(luvio));
+});
+
+export { ingestRecord };
+// version: 1.100.2-ca56bb821

package/src/raml/api.raml

@@ -0,0 +1,89 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '54.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  MicrobatchingIngestionInputWrapperRepresentation: # TODO Hand-rolled W-8334626
+    description: Wrapper Microbatching Ingestion Input Representation
+    type: object
+    properties:
+      requestIngestionInput:
+        description: Set parameters for ingestion.
+        type: MicrobatchingIngestionInputRepresentation
+  MicrobatchingIngestionInputRepresentation:
+    description: Microbatching Ingestion Input Representation
+    type: object
+    properties:
+      groupBy:
+        description: GroupBy
+        type: string
+        required: false # TODO handrolled W-9314597
+      keyPrefix:
+        description: KeyPrefix
+        type: string
+        required: false # TODO handrolled W-9314597
+      processType:
+        description: ProcessType
+        type: string
+      requestBody:
+        description: RequestBody
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-10049570
+  MicrobatchingIngestionOutputRepresentation:
+    description: Representation for microbatching buffering response
+    type: object
+    properties:
+      recordUUID:
+        description: UUID of the ingested record
+        type: string
+  MicrobatchingIngestionRequestBodyInputRepresentation:
+    description: Encapsulates request body payload
+    type: object
+    properties:
+      requestBody:
+        description: RequestBody
+        type: object
+        properties:
+          //:
+            type: object
+/connect/communities/{communityId}/microbatching:
+  post:
+    description: Microbatching record ingestion.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: MicrobatchingIngestionOutputRepresentation
+    body:
+      application/json:
+        type: MicrobatchingIngestionInputWrapperRepresentation
+        (oas-body-name): requestIngestionInput
+  uriParameters:
+    communityId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'microbatching'
+
+types:
+  MicrobatchingIngestionOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      recordUUID: recordUUID
+
+/connect/communities/{communityId}/microbatching:
+  post:
+    (luvio.adapter):
+      name: ingestRecord