@salesforce/lds-adapters-service-data-category 1.224.0

package/sfdc/index.js

@@ -0,0 +1,485 @@
+/**
+ * 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 { createInstrumentedAdapter, createLDSAdapter, createWireAdapterConstructor, createImperativeAdapter } from 'force/ldsBindings';
+import { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, ingestShape, deepFreeze, buildNetworkSnapshotCachePolicy as buildNetworkSnapshotCachePolicy$1, StoreKeyMap, createResourceParams as createResourceParams$1 } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys, create: ObjectCreate } = 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(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 snapshotRefreshOptions = {
+    overrides: {
+        headers: {
+            'Cache-Control': 'no-cache',
+        },
+    }
+};
+function buildAdapterValidationConfig(displayName, paramsMeta) {
+    const required = paramsMeta.filter(p => p.required).map(p => p.name);
+    const optional = paramsMeta.filter(p => !p.required).map(p => p.name);
+    return {
+        displayName,
+        parameters: {
+            required,
+            optional,
+        }
+    };
+}
+const keyPrefix = 'DataCategory';
+
+const { isArray: ArrayIsArray } = Array;
+const { stringify: JSONStringify } = JSON;
+function equalsArray(a, b, equalsItem) {
+    const aLength = a.length;
+    const bLength = b.length;
+    if (aLength !== bLength) {
+        return false;
+    }
+    for (let i = 0; i < aLength; i++) {
+        if (equalsItem(a[i], b[i]) === false) {
+            return false;
+        }
+    }
+    return true;
+}
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+const VERSION$2 = "ccff9545652601c1888a16f5eb7ae564";
+function validate$2(obj, path = 'DataCategoryRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_categoryName = obj.categoryName;
+        const path_categoryName = path + '.categoryName';
+        if (typeof obj_categoryName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_categoryName + '" (at "' + path_categoryName + '")');
+        }
+        const obj_childCategories = obj.childCategories;
+        const path_childCategories = path + '.childCategories';
+        if (!ArrayIsArray(obj_childCategories)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_childCategories + '" (at "' + path_childCategories + '")');
+        }
+        for (let i = 0; i < obj_childCategories.length; i++) {
+            const obj_childCategories_item = obj_childCategories[i];
+            const path_childCategories_item = path_childCategories + '[' + i + ']';
+            if (obj_childCategories_item === undefined) {
+                return new TypeError('Expected "defined" but received "' + typeof obj_childCategories_item + '" (at "' + path_childCategories_item + '")');
+            }
+        }
+        const obj_label = obj.label;
+        const path_label = path + '.label';
+        if (typeof obj_label !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_label + '" (at "' + path_label + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$3 = function DataCategoryRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION$2,
+        private: [],
+        selections: [
+            {
+                name: 'categoryName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'childCategories',
+                kind: 'Object',
+                // any
+            },
+            {
+                name: 'label',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$2(existing, incoming) {
+    const existing_categoryName = existing.categoryName;
+    const incoming_categoryName = incoming.categoryName;
+    if (!(existing_categoryName === incoming_categoryName)) {
+        return false;
+    }
+    const existing_label = existing.label;
+    const incoming_label = incoming.label;
+    if (!(existing_label === incoming_label)) {
+        return false;
+    }
+    const existing_childCategories = existing.childCategories;
+    const incoming_childCategories = incoming.childCategories;
+    const equals_childCategories_items = equalsArray(existing_childCategories, incoming_childCategories, (existing_childCategories_item, incoming_childCategories_item) => {
+        if (JSONStringify(incoming_childCategories_item) !== JSONStringify(existing_childCategories_item)) {
+            return false;
+        }
+    });
+    if (equals_childCategories_items === false) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION$1 = "bb3ad8223c9402993b9efe107748e116";
+function validate$1(obj, path = 'DataCategoryGroupRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_categoryGroupName = obj.categoryGroupName;
+        const path_categoryGroupName = path + '.categoryGroupName';
+        if (typeof obj_categoryGroupName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_categoryGroupName + '" (at "' + path_categoryGroupName + '")');
+        }
+        const obj_description = obj.description;
+        const path_description = path + '.description';
+        if (typeof obj_description !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_description + '" (at "' + path_description + '")');
+        }
+        const obj_label = obj.label;
+        const path_label = path + '.label';
+        if (typeof obj_label !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_label + '" (at "' + path_label + '")');
+        }
+        const obj_rootCategory = obj.rootCategory;
+        const path_rootCategory = path + '.rootCategory';
+        const referencepath_rootCategoryValidationError = validate$2(obj_rootCategory, path_rootCategory);
+        if (referencepath_rootCategoryValidationError !== null) {
+            let message = 'Object doesn\'t match DataCategoryRepresentation (at "' + path_rootCategory + '")\n';
+            message += referencepath_rootCategoryValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$2 = function DataCategoryGroupRepresentationSelect() {
+    const { selections: DataCategoryRepresentation__selections, opaque: DataCategoryRepresentation__opaque, } = select$3();
+    return {
+        kind: 'Fragment',
+        version: VERSION$1,
+        private: [],
+        selections: [
+            {
+                name: 'categoryGroupName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'description',
+                kind: 'Scalar'
+            },
+            {
+                name: 'label',
+                kind: 'Scalar'
+            },
+            {
+                name: 'rootCategory',
+                kind: 'Object',
+                selections: DataCategoryRepresentation__selections
+            }
+        ]
+    };
+};
+function equals$1(existing, incoming) {
+    const existing_categoryGroupName = existing.categoryGroupName;
+    const incoming_categoryGroupName = incoming.categoryGroupName;
+    if (!(existing_categoryGroupName === incoming_categoryGroupName)) {
+        return false;
+    }
+    const existing_description = existing.description;
+    const incoming_description = incoming.description;
+    if (!(existing_description === incoming_description)) {
+        return false;
+    }
+    const existing_label = existing.label;
+    const incoming_label = incoming.label;
+    if (!(existing_label === incoming_label)) {
+        return false;
+    }
+    const existing_rootCategory = existing.rootCategory;
+    const incoming_rootCategory = incoming.rootCategory;
+    if (!(equals$2(existing_rootCategory, incoming_rootCategory))) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION = "db13362abaa16e37af68b2073902b190";
+function validate(obj, path = 'DataCategoryGroupCollectionRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_dataCategoryGroups = obj.dataCategoryGroups;
+        const path_dataCategoryGroups = path + '.dataCategoryGroups';
+        if (!ArrayIsArray(obj_dataCategoryGroups)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_dataCategoryGroups + '" (at "' + path_dataCategoryGroups + '")');
+        }
+        for (let i = 0; i < obj_dataCategoryGroups.length; i++) {
+            const obj_dataCategoryGroups_item = obj_dataCategoryGroups[i];
+            const path_dataCategoryGroups_item = path_dataCategoryGroups + '[' + i + ']';
+            const referencepath_dataCategoryGroups_itemValidationError = validate$1(obj_dataCategoryGroups_item, path_dataCategoryGroups_item);
+            if (referencepath_dataCategoryGroups_itemValidationError !== null) {
+                let message = 'Object doesn\'t match DataCategoryGroupRepresentation (at "' + path_dataCategoryGroups_item + '")\n';
+                message += referencepath_dataCategoryGroups_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'DataCategoryGroupCollectionRepresentation';
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function DataCategoryGroupCollectionRepresentationSelect() {
+    const { selections: DataCategoryGroupRepresentation__selections, opaque: DataCategoryGroupRepresentation__opaque, } = select$2();
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'dataCategoryGroups',
+                kind: 'Object',
+                plural: true,
+                selections: DataCategoryGroupRepresentation__selections
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_dataCategoryGroups = existing.dataCategoryGroups;
+    const incoming_dataCategoryGroups = incoming.dataCategoryGroups;
+    const equals_dataCategoryGroups_items = equalsArray(existing_dataCategoryGroups, incoming_dataCategoryGroups, (existing_dataCategoryGroups_item, incoming_dataCategoryGroups_item) => {
+        if (!(equals$1(existing_dataCategoryGroups_item, incoming_dataCategoryGroups_item))) {
+            return false;
+        }
+    });
+    if (equals_dataCategoryGroups_items === false) {
+        return false;
+    }
+    return true;
+}
+const ingest = function DataCategoryGroupCollectionRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = path.fullPath;
+    const ttlToUse = path.ttl !== undefined ? path.ttl : 900000;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize, "DataCategory", VERSION, RepresentationType, equals);
+    return createLink(key);
+};
+function getTypeCacheKeys(rootKeySet, luvio, input, fullPathFactory) {
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = fullPathFactory();
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function keyBuilder$1(luvio, params) {
+    return keyPrefix + '::DataCategoryGroupCollectionRepresentation:(' + ')';
+}
+function getResponseCacheKeys(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys(storeKeyMap, luvio, response, () => keyBuilder$1());
+}
+function ingestSuccess(luvio, resourceParams, response, snapshotRefresh) {
+    const { body } = response;
+    const key = keyBuilder$1();
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select(),
+        variables: {},
+    }, snapshotRefresh);
+    if (process.env.NODE_ENV !== 'production') {
+        if (snapshot.state !== 'Fulfilled') {
+            throw new Error('Invalid network response. Expected resource response to result in Fulfilled snapshot');
+        }
+    }
+    deepFreeze(snapshot.data);
+    return snapshot;
+}
+function ingestError(luvio, params, error, snapshotRefresh) {
+    const key = keyBuilder$1();
+    const errorSnapshot = luvio.errorSnapshot(error, snapshotRefresh);
+    luvio.storeIngestError(key, errorSnapshot);
+    return errorSnapshot;
+}
+function createResourceRequest(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v59.0',
+        basePath: '/connect/data-category/category-group',
+        method: 'get',
+        body: null,
+        urlParams: {},
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName = 'getCategoryGroups';
+const getCategoryGroups_ConfigPropertyMetadata = [];
+const getCategoryGroups_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, getCategoryGroups_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$1(getCategoryGroups_ConfigPropertyMetadata);
+function keyBuilder(luvio, config) {
+    createResourceParams(config);
+    return keyBuilder$1();
+}
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    return config;
+}
+function validateAdapterConfig(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig();
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function adapterFragment(luvio, config) {
+    createResourceParams(config);
+    return select();
+}
+function onFetchResponseSuccess(luvio, config, resourceParams, response) {
+    const snapshot = ingestSuccess(luvio, resourceParams, response, {
+        config,
+        resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+    });
+    return luvio.storeBroadcast().then(() => snapshot);
+}
+function onFetchResponseError(luvio, config, resourceParams, response) {
+    const snapshot = ingestError(luvio, resourceParams, response, {
+        config,
+        resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+    });
+    return luvio.storeBroadcast().then(() => snapshot);
+}
+function buildNetworkSnapshot(luvio, config, options) {
+    const resourceParams = createResourceParams(config);
+    const request = createResourceRequest();
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => onFetchResponseSuccess(luvio, config, resourceParams, response), () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        return luvio.handleErrorResponse(() => onFetchResponseError(luvio, config, resourceParams, response));
+    });
+}
+function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext) {
+    return buildNetworkSnapshotCachePolicy$1(context, coercedAdapterRequestContext, buildNetworkSnapshot, undefined, false);
+}
+function buildCachedSnapshotCachePolicy(context, storeLookup) {
+    const { luvio, config } = context;
+    const selector = {
+        recordId: keyBuilder(luvio, config),
+        node: adapterFragment(luvio, config),
+        variables: {},
+    };
+    const cacheSnapshot = storeLookup(selector, {
+        config,
+        resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+    });
+    return cacheSnapshot;
+}
+const getCategoryGroupsAdapterFactory = (luvio) => function DataCategory__getCategoryGroups(untrustedConfig, requestContext) {
+    const config = validateAdapterConfig(untrustedConfig, getCategoryGroups_ConfigPropertyNames);
+    // Invalid or incomplete config
+    if (config === null) {
+        return null;
+    }
+    return luvio.applyCachePolicy((requestContext || {}), { config, luvio }, // BuildSnapshotContext
+    buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy);
+};
+
+let getCategoryGroups;
+// Imperative GET Adapters
+let getCategoryGroups_imperative;
+// Adapter Metadata
+const getCategoryGroupsMetadata = { apiFamily: 'DataCategory', name: 'getCategoryGroups' };
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    const getCategoryGroups_ldsAdapter = createInstrumentedAdapter(createLDSAdapter(luvio, 'getCategoryGroups', getCategoryGroupsAdapterFactory), getCategoryGroupsMetadata);
+    return {
+        getCategoryGroups: createWireAdapterConstructor(luvio, getCategoryGroups_ldsAdapter, getCategoryGroupsMetadata),
+        // Imperative GET Adapters
+        getCategoryGroups_imperative: createImperativeAdapter(luvio, getCategoryGroups_ldsAdapter, getCategoryGroupsMetadata)
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({
+        getCategoryGroups,
+        getCategoryGroups_imperative
+    } = bindExportsTo(luvio));
+});
+
+export { getCategoryGroups, getCategoryGroups_imperative };
+// version: 1.224.0-b4cf8fe20

package/src/raml/api.raml

@@ -0,0 +1,78 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v59.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:
+  DataCategoryGroupCollectionRepresentation:
+    description: Data Category Group Collection Representation
+    type: object
+    properties:
+      dataCategoryGroups:
+        description: Collection of Data Category Groups
+        type: array
+        items:
+          type: DataCategoryGroupRepresentation
+  DataCategoryGroupRepresentation:
+    description: Data Category Group Representation
+    type: object
+    properties:
+      categoryGroupName:
+        description: Developer Name of the Data Category Group
+        type: string
+      description:
+        description: Description of the Data Category Group
+        type: string
+      label:
+        description: Label of the Data Category Group
+        type: string
+      rootCategory:
+        description: Root Category of the Data Category Group
+        type: DataCategoryRepresentation
+  DataCategoryRepresentation:
+    description: Data Category Representation
+    type: object
+    properties:
+      categoryName:
+        description: Developer Name of the Data Category
+        type: string
+      childCategories:
+        description: List of child data categories
+        type: array
+        items:
+          type: any # This is a workaround because recursive (tree) representations aren't supported in Luvio, even though they're supported in Connect API
+      label:
+        description: Label of the Data Category
+        type: string
+/connect:
+  /data-category/category-group:
+    get:
+      displayName: getCategoryGroups
+      description: Returns all active data category groups and their child categories
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataCategoryGroupCollectionRepresentation

package/src/raml/luvio.raml

@@ -0,0 +1,14 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'DataCategory'
+(luvio.ttl): 900000
+
+/connect:
+  /data-category/category-group:
+    get:
+      (luvio.adapter):
+        name: getCategoryGroups