@vannizhang/living-atlas-content-validator 1.5.17 → 1.5.18-beta.2

package/dist/services/content-validator-assets/fetchAdditonalPatterns4TitleAndSnippetSearchability.js

@@ -0,0 +1,92 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAdditonalPatterns4TitleAndSnippetSearchability = void 0;
+const helpers_1 = require("./helpers");
+/**
+ * Fetches additional pattern rules for validating the searchability of titles and snippets.
+ *
+ * This function retrieves additional matching and rejected patterns for different categories,
+ * including location, source, topic, and year vintage. These patterns help determine whether
+ * a title or snippet is valid for searchability.
+ *
+ * @param {string} language - The language code (e.g., "en", "es", "fr") to fetch the appropriate localized patterns. The default is "en".
+ * @returns {Promise<AdditionalPattern>} A promise resolving to an object containing categorized matching and rejected patterns.
+ *
+ * @example
+ * ```typescript
+ * const patterns = await fetchPatternRulesForTitleSearchability("en");
+ * console.log(patterns.matchingPatternsLocation); // ["New York", "Los Angeles"]
+ * ```
+ */
+const fetchAdditonalPatterns4TitleAndSnippetSearchability = (language = 'en') => __awaiter(void 0, void 0, void 0, function* () {
+    const queryTimestamp = (0, helpers_1.getRoundedTimestamp)(1);
+    const assetsFolderPath = (0, helpers_1.getAssetFolderPath)();
+    // add the timestamp to the request URL to avoid cdn caching
+    const requestURL = `${assetsFolderPath}/check-title-snippet-searchability/additional-patterns.${language}.json?timestamp=${queryTimestamp}`;
+    try {
+        const response = yield fetch(requestURL);
+        if (!response.ok || response.status === 404) {
+            throw new Error(`Error fetching additional patterns: ${response.statusText}`);
+        }
+        const data = yield response.json();
+        // console.log('data', data);
+        if (!data || typeof data !== 'object' || Array.isArray(data)) {
+            throw new Error(`Invalid JSON format received for language: ${language}`);
+        }
+        if (!data['matchingPatternsLocation'] ||
+            !data['rejectedPatternsLocation'] ||
+            !data['matchingPatternsSource'] ||
+            !data['rejectedPatternsSource'] ||
+            !data['matchingPatternsTopic'] ||
+            !data['rejectedPatternsTopic'] ||
+            !data['matchingPatternsYearVintage'] ||
+            !data['rejectedPatternsYearVintage']) {
+            throw new Error(`Missing required fields in the JSON data`);
+        }
+        const matchingPatternsLocation = data['matchingPatternsLocation'] || [];
+        const rejectedPatternsLocation = data['rejectedPatternsLocation'] || [];
+        const matchingPatternsSource = data['matchingPatternsSource'] || [];
+        const rejectedPatternsSource = data['rejectedPatternsSource'] || [];
+        const matchingPatternsTopic = data['matchingPatternsTopic'] || [];
+        const rejectedPatternsTopic = data['rejectedPatternsTopic'] || [];
+        const matchingPatternsYearVintage = data['matchingPatternsYearVintage'] || [];
+        const rejectedPatternsYearVintage = data['rejectedPatternsYearVintage'] || [];
+        return {
+            matchingPatternsLocation,
+            rejectedPatternsLocation,
+            matchingPatternsSource,
+            rejectedPatternsSource,
+            matchingPatternsTopic,
+            rejectedPatternsTopic,
+            matchingPatternsYearVintage,
+            rejectedPatternsYearVintage,
+            updatedAt: data['updatedAt'],
+        };
+    }
+    catch (error) {
+        console.error(`Error fetching pattern rules for language: ${language}`, error);
+        throw new Error((error === null || error === void 0 ? void 0 : error.message) ||
+            `Error fetching pattern rules for language: ${language}`);
+        // return {
+        //     matchingPatternsLocation: [],
+        //     rejectedPatternsLocation: [],
+        //     matchingPatternsSource: [],
+        //     rejectedPatternsSource: [],
+        //     matchingPatternsTopic: [],
+        //     rejectedPatternsTopic: [],
+        //     matchingPatternsYearVintage: [],
+        //     rejectedPatternsYearVintage: [],
+        // };
+    }
+});
+exports.fetchAdditonalPatterns4TitleAndSnippetSearchability = fetchAdditonalPatterns4TitleAndSnippetSearchability;
+//# sourceMappingURL=fetchAdditonalPatterns4TitleAndSnippetSearchability.js.map

package/dist/services/content-validator-assets/fetchAdditonalPatterns4TitleAndSnippetSearchability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchAdditonalPatterns4TitleAndSnippetSearchability.js","sourceRoot":"","sources":["../../../src/services/content-validator-assets/fetchAdditonalPatterns4TitleAndSnippetSearchability.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAoE;AAiFpE;;;;;;;;;;;;;;;GAeG;AACI,MAAM,mDAAmD,GAAG,CAC/D,QAAQ,GAAG,IAAI,EACyC,EAAE;IAC1D,MAAM,cAAc,GAAG,IAAA,6BAAmB,EAAC,CAAC,CAAC,CAAC;IAE9C,MAAM,gBAAgB,GAAG,IAAA,4BAAkB,GAAE,CAAC;IAE9C,4DAA4D;IAC5D,MAAM,UAAU,GAAG,GAAG,gBAAgB,0DAA0D,QAAQ,mBAAmB,cAAc,EAAE,CAAC;IAE5I,IAAI;QACA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC;QAEzC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YACzC,MAAM,IAAI,KAAK,CACX,uCAAuC,QAAQ,CAAC,UAAU,EAAE,CAC/D,CAAC;SACL;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,6BAA6B;QAE7B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC1D,MAAM,IAAI,KAAK,CACX,8CAA8C,QAAQ,EAAE,CAC3D,CAAC;SACL;QAED,IACI,CAAC,IAAI,CAAC,0BAA0B,CAAC;YACjC,CAAC,IAAI,CAAC,0BAA0B,CAAC;YACjC,CAAC,IAAI,CAAC,wBAAwB,CAAC;YAC/B,CAAC,IAAI,CAAC,wBAAwB,CAAC;YAC/B,CAAC,IAAI,CAAC,uBAAuB,CAAC;YAC9B,CAAC,IAAI,CAAC,uBAAuB,CAAC;YAC9B,CAAC,IAAI,CAAC,6BAA6B,CAAC;YACpC,CAAC,IAAI,CAAC,6BAA6B,CAAC,EACtC;YACE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC/D;QAED,MAAM,wBAAwB,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAC;QACxE,MAAM,wBAAwB,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAC;QACxE,MAAM,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC;QACpE,MAAM,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC;QACpE,MAAM,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC;QAClE,MAAM,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC;QAClE,MAAM,2BAA2B,GAC7B,IAAI,CAAC,6BAA6B,CAAC,IAAI,EAAE,CAAC;QAC9C,MAAM,2BAA2B,GAC7B,IAAI,CAAC,6BAA6B,CAAC,IAAI,EAAE,CAAC;QAE9C,OAAO;YACH,wBAAwB;YACxB,wBAAwB;YACxB,sBAAsB;YACtB,sBAAsB;YACtB,qBAAqB;YACrB,qBAAqB;YACrB,2BAA2B;YAC3B,2BAA2B;YAC3B,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;SAC/B,CAAC;KACL;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CACT,8CAA8C,QAAQ,EAAE,EACxD,KAAK,CACR,CAAC;QAEF,MAAM,IAAI,KAAK,CACX,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO;YACV,8CAA8C,QAAQ,EAAE,CAC/D,CAAC;QAEF,WAAW;QACX,oCAAoC;QACpC,oCAAoC;QACpC,kCAAkC;QAClC,kCAAkC;QAClC,iCAAiC;QACjC,iCAAiC;QACjC,uCAAuC;QACvC,uCAAuC;QACvC,KAAK;KACR;AACL,CAAC,CAAA,CAAC;AArFW,QAAA,mDAAmD,uDAqF9D"}

package/dist/services/content-validator-assets/fetchProfanitiesData.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Fetches profanities data for a specified language from a remote source.
+ *
+ * This function retrieves a list of profane terms from a JSON file located in the assets folder.
+ * The URL includes a timestamp to prevent CDN caching.
+ *
+ * @param language - The language code for which to fetch profanities. Defaults to 'en' (English).
+ * @returns A Promise that resolves to an array of strings containing profanity terms.
+ * @throws {Error} If the fetch request fails, returns a 404, or if the response contains invalid data.
+ *
+ * @example
+ * // Fetch English profanities
+ * const englishProfanities = await fetchProfanitiesData();
+ *
+ * // Fetch Spanish profanities
+ * const spanishProfanities = await fetchProfanitiesData('es');
+ */
+export declare const fetchProfanitiesData: (language?: string) => Promise<string[]>;

package/dist/services/content-validator-assets/fetchProfanitiesData.js

@@ -0,0 +1,55 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchProfanitiesData = void 0;
+const helpers_1 = require("./helpers");
+/**
+ * Fetches profanities data for a specified language from a remote source.
+ *
+ * This function retrieves a list of profane terms from a JSON file located in the assets folder.
+ * The URL includes a timestamp to prevent CDN caching.
+ *
+ * @param language - The language code for which to fetch profanities. Defaults to 'en' (English).
+ * @returns A Promise that resolves to an array of strings containing profanity terms.
+ * @throws {Error} If the fetch request fails, returns a 404, or if the response contains invalid data.
+ *
+ * @example
+ * // Fetch English profanities
+ * const englishProfanities = await fetchProfanitiesData();
+ *
+ * // Fetch Spanish profanities
+ * const spanishProfanities = await fetchProfanitiesData('es');
+ */
+const fetchProfanitiesData = (language = 'en') => __awaiter(void 0, void 0, void 0, function* () {
+    const queryTimestamp = (0, helpers_1.getRoundedTimestamp)(1);
+    const assetsFolderPath = (0, helpers_1.getAssetFolderPath)();
+    // add the timestamp to the request URL to avoid cdn caching
+    const requestURL = `${assetsFolderPath}/check-profanity/profanities.${language}.json?timestamp=${queryTimestamp}`;
+    try {
+        const response = yield fetch(requestURL);
+        if (!response.ok || response.status === 404) {
+            throw new Error(`Error fetching profanities data: ${response.statusText}`);
+        }
+        const data = yield response.json();
+        // console.log('data', data);
+        if (!data || typeof data !== 'object' || !Array.isArray(data)) {
+            throw new Error(`Invalid JSON format received for language: ${language}`);
+        }
+        return data || [];
+    }
+    catch (error) {
+        console.error(`Error fetching profanities data for language: ${language}`, error);
+        throw new Error((error === null || error === void 0 ? void 0 : error.message) ||
+            `Error fetching profanities data for language: ${language}`);
+    }
+});
+exports.fetchProfanitiesData = fetchProfanitiesData;
+//# sourceMappingURL=fetchProfanitiesData.js.map

package/dist/services/content-validator-assets/fetchProfanitiesData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchProfanitiesData.js","sourceRoot":"","sources":["../../../src/services/content-validator-assets/fetchProfanitiesData.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAoE;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,oBAAoB,GAAG,CAChC,QAAQ,GAAG,IAAI,EACE,EAAE;IACnB,MAAM,cAAc,GAAG,IAAA,6BAAmB,EAAC,CAAC,CAAC,CAAC;IAE9C,MAAM,gBAAgB,GAAG,IAAA,4BAAkB,GAAE,CAAC;IAE9C,4DAA4D;IAC5D,MAAM,UAAU,GAAG,GAAG,gBAAgB,gCAAgC,QAAQ,mBAAmB,cAAc,EAAE,CAAC;IAElH,IAAI;QACA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC;QAEzC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YACzC,MAAM,IAAI,KAAK,CACX,oCAAoC,QAAQ,CAAC,UAAU,EAAE,CAC5D,CAAC;SACL;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,6BAA6B;QAE7B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CACX,8CAA8C,QAAQ,EAAE,CAC3D,CAAC;SACL;QAED,OAAO,IAAI,IAAI,EAAE,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CACT,iDAAiD,QAAQ,EAAE,EAC3D,KAAK,CACR,CAAC;QAEF,MAAM,IAAI,KAAK,CACX,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO;YACV,iDAAiD,QAAQ,EAAE,CAClE,CAAC;KACL;AACL,CAAC,CAAA,CAAC;AAxCW,QAAA,oBAAoB,wBAwC/B"}

package/dist/services/content-validator-assets/helpers.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns a rounded timestamp based on the specified number of minutes.
+ * @param {number} numOfMin - The number of minutes to round the timestamp to. Defaults to 5 if not provided.
+ * @returns {number} The rounded timestamp in milliseconds.
+ */
+export declare const getRoundedTimestamp: (numOfMin?: number) => number;
+/**
+ * Retrieves the asset folder path based on the environment.
+ *
+ * If the environment is not Node.js, it returns the predefined `ASSETS_FOLDER_PATH`.
+ * Otherwise, it constructs the URL based on the service tier (development or production)
+ * and appends the `ASSETS_FOLDER_PATH` to it.
+ *
+ * @returns {string} The asset folder path.
+ */
+export declare const getAssetFolderPath: () => string;

package/dist/services/content-validator-assets/helpers.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAssetFolderPath = exports.getRoundedTimestamp = void 0;
+const config_1 = require("../shared/config");
+const config_2 = require("./config");
+/**
+ * Returns a rounded timestamp based on the specified number of minutes.
+ * @param {number} numOfMin - The number of minutes to round the timestamp to. Defaults to 5 if not provided.
+ * @returns {number} The rounded timestamp in milliseconds.
+ */
+const getRoundedTimestamp = (numOfMin = 5) => {
+    const coeff = 1000 * 60 * numOfMin;
+    return Math.floor(Date.now() / coeff) * coeff; // Keeps milliseconds
+};
+exports.getRoundedTimestamp = getRoundedTimestamp;
+/**
+ * Retrieves the asset folder path based on the environment.
+ *
+ * If the environment is not Node.js, it returns the predefined `ASSETS_FOLDER_PATH`.
+ * Otherwise, it constructs the URL based on the service tier (development or production)
+ * and appends the `ASSETS_FOLDER_PATH` to it.
+ *
+ * @returns {string} The asset folder path.
+ */
+const getAssetFolderPath = () => {
+    if (!config_1.isNodeEnv) {
+        return config_2.ASSETS_FOLDER_PATH;
+    }
+    const hostname = config_1.serviceTier === 'dev'
+        ? 'https://livingatlasdev.arcgis.com'
+        : 'https://livingatlas.arcgis.com';
+    return hostname + config_2.ASSETS_FOLDER_PATH;
+};
+exports.getAssetFolderPath = getAssetFolderPath;
+//# sourceMappingURL=helpers.js.map

package/dist/services/content-validator-assets/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/services/content-validator-assets/helpers.ts"],"names":[],"mappings":";;;AAAA,6CAA0D;AAC1D,qCAA8C;AAE9C;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,CAAC,QAAQ,GAAG,CAAC,EAAE,EAAE;IAChD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,GAAG,QAAQ,CAAC;IACnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,qBAAqB;AACxE,CAAC,CAAC;AAHW,QAAA,mBAAmB,uBAG9B;AAEF;;;;;;;;GAQG;AACI,MAAM,kBAAkB,GAAG,GAAG,EAAE;IACnC,IAAI,CAAC,kBAAS,EAAE;QACZ,OAAO,2BAAkB,CAAC;KAC7B;IAED,MAAM,QAAQ,GACV,oBAAW,KAAK,KAAK;QACjB,CAAC,CAAC,mCAAmC;QACrC,CAAC,CAAC,gCAAgC,CAAC;IAE3C,OAAO,QAAQ,GAAG,2BAAkB,CAAC;AACzC,CAAC,CAAC;AAXW,QAAA,kBAAkB,sBAW7B"}

package/dist/services/custom-terms/config.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This enum defines the field names used in the Custom Terms feature table.
+ */
+export declare enum CustomTermsFeatureTableField {
+    OBJECT_ID = "OBJECTID",
+    TERM = "term",
+    CATEGORY = "category",
+    STATUS = "status",
+    TITLE = "item_title",
+    ITEM_ID = "item_id",
+    SNIPPET = "item_snippet",
+    NOTE = "note",
+    CREATION_DATE = "CreationDate",
+    CREATOR = "Creator",
+    EDIT_DATE = "EditDate",
+    EDITOR = "Editor"
+}
+/**
+ * Gets the URL for the Custom Terms feature table based on the service tier.
+ * @returns the URL for the Custom Terms feature table.
+ */
+export declare const getCustomTermsFeatureTableUrl: () => string;
+/**
+ * Gets the URL for the itemInfo endpoint for the Custom Terms feature table.
+ * @returns The URL for the itemInfo endpoint for the Custom Terms feature table.
+ */
+export declare const getCustomTermsFeatureTableItemInfoUrl: () => string;

package/dist/services/custom-terms/config.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCustomTermsFeatureTableItemInfoUrl = exports.getCustomTermsFeatureTableUrl = exports.CustomTermsFeatureTableField = void 0;
+const config_1 = require("../shared/config");
+/**
+ * The root URL for the Custom Terms feature table in the development environment.
+ * @see
+ * https://servicesdev.arcgis.com/VLx4vrvwONglS8iz/ArcGIS/rest/services/Custom_Terms/FeatureServer
+ */
+const CUSTOM_TERMS_FEATURE_TABLE_ROOT_DEV = 'https://servicesdev.arcgis.com/VLx4vrvwONglS8iz/arcgis/rest/services/Custom_Terms/FeatureServer';
+/**
+ * The URL for the Custom Terms feature table in the development environment.
+ * @see
+ * https://servicesdev.arcgis.com/VLx4vrvwONglS8iz/ArcGIS/rest/services/Custom_Terms/FeatureServer/0
+ */
+const CUSTOM_TERMS_FEATURE_TABLE_URL_DEV = CUSTOM_TERMS_FEATURE_TABLE_ROOT_DEV + '/0';
+/**
+ * The URL for the itemInfo endpoint for the Custom Terms feature table in the development environment.
+ * @see
+ * https://servicesdev.arcgis.com/VLx4vrvwONglS8iz/ArcGIS/rest/services/Custom_Terms/FeatureServer/info/itemInfo
+ */
+const CUSTOM_TERMS_FEATURE_TABLE_ITEMINFO_DEV = CUSTOM_TERMS_FEATURE_TABLE_ROOT_DEV + '/info/itemInfo';
+/**
+ * The root URL for the Custom Terms feature table in the production environment.
+ * @see
+ * https://services.arcgis.com/jIL9msH9OI208GCb/arcgis/rest/services/Custom_Terms/FeatureServer
+ */
+const CUSTOM_TERMS_FEATURE_TABLE_ROOT_PROD = 'https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/Custom_Terms/FeatureServer';
+/**
+ * The URL for the Custom Terms feature table in the production environment.
+ * @see
+ * https://services.arcgis.com/jIL9msH9OI208GCb/ArcGIS/rest/services/Custom_Terms/FeatureServer/0
+ */
+const CUSTOM_TERMS_FEATURE_TABLE_URL_PROD = CUSTOM_TERMS_FEATURE_TABLE_ROOT_PROD + '/0';
+/**
+ * The URL for the itemInfo endpoint for the Custom Terms feature table in the production environment.
+ * @see
+ * https://services.arcgis.com/jIL9msH9OI208GCb/ArcGIS/rest/services/Custom_Terms/FeatureServer/info/itemInfo
+ */
+const CUSTOM_TERMS_FEATURE_TABLE_ITEMINFO_PROD = CUSTOM_TERMS_FEATURE_TABLE_ROOT_PROD + '/info/itemInfo';
+/**
+ * This enum defines the field names used in the Custom Terms feature table.
+ */
+var CustomTermsFeatureTableField;
+(function (CustomTermsFeatureTableField) {
+    CustomTermsFeatureTableField["OBJECT_ID"] = "OBJECTID";
+    CustomTermsFeatureTableField["TERM"] = "term";
+    CustomTermsFeatureTableField["CATEGORY"] = "category";
+    CustomTermsFeatureTableField["STATUS"] = "status";
+    CustomTermsFeatureTableField["TITLE"] = "item_title";
+    CustomTermsFeatureTableField["ITEM_ID"] = "item_id";
+    CustomTermsFeatureTableField["SNIPPET"] = "item_snippet";
+    CustomTermsFeatureTableField["NOTE"] = "note";
+    CustomTermsFeatureTableField["CREATION_DATE"] = "CreationDate";
+    CustomTermsFeatureTableField["CREATOR"] = "Creator";
+    CustomTermsFeatureTableField["EDIT_DATE"] = "EditDate";
+    CustomTermsFeatureTableField["EDITOR"] = "Editor";
+})(CustomTermsFeatureTableField = exports.CustomTermsFeatureTableField || (exports.CustomTermsFeatureTableField = {}));
+/**
+ * Gets the URL for the Custom Terms feature table based on the service tier.
+ * @returns the URL for the Custom Terms feature table.
+ */
+const getCustomTermsFeatureTableUrl = () => {
+    return config_1.serviceTier === 'prod'
+        ? CUSTOM_TERMS_FEATURE_TABLE_URL_PROD
+        : CUSTOM_TERMS_FEATURE_TABLE_URL_DEV;
+};
+exports.getCustomTermsFeatureTableUrl = getCustomTermsFeatureTableUrl;
+/**
+ * Gets the URL for the itemInfo endpoint for the Custom Terms feature table.
+ * @returns The URL for the itemInfo endpoint for the Custom Terms feature table.
+ */
+const getCustomTermsFeatureTableItemInfoUrl = () => {
+    return config_1.serviceTier === 'prod'
+        ? CUSTOM_TERMS_FEATURE_TABLE_ITEMINFO_PROD
+        : CUSTOM_TERMS_FEATURE_TABLE_ITEMINFO_DEV;
+};
+exports.getCustomTermsFeatureTableItemInfoUrl = getCustomTermsFeatureTableItemInfoUrl;
+//# sourceMappingURL=config.js.map

package/dist/services/custom-terms/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/services/custom-terms/config.ts"],"names":[],"mappings":";;;AAAA,6CAA+C;AAE/C;;;;GAIG;AACH,MAAM,mCAAmC,GACrC,iGAAiG,CAAC;AAEtG;;;;GAIG;AACH,MAAM,kCAAkC,GACpC,mCAAmC,GAAG,IAAI,CAAC;AAE/C;;;;GAIG;AACH,MAAM,uCAAuC,GACzC,mCAAmC,GAAG,gBAAgB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,oCAAoC,GACtC,8FAA8F,CAAC;AAEnG;;;;GAIG;AACH,MAAM,mCAAmC,GACrC,oCAAoC,GAAG,IAAI,CAAC;AAEhD;;;;GAIG;AACH,MAAM,wCAAwC,GAC1C,oCAAoC,GAAG,gBAAgB,CAAC;AAE5D;;GAEG;AACH,IAAY,4BAaX;AAbD,WAAY,4BAA4B;IACpC,sDAAsB,CAAA;IACtB,6CAAa,CAAA;IACb,qDAAqB,CAAA;IACrB,iDAAiB,CAAA;IACjB,oDAAoB,CAAA;IACpB,mDAAmB,CAAA;IACnB,wDAAwB,CAAA;IACxB,6CAAa,CAAA;IACb,8DAA8B,CAAA;IAC9B,mDAAmB,CAAA;IACnB,sDAAsB,CAAA;IACtB,iDAAiB,CAAA;AACrB,CAAC,EAbW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAavC;AAED;;;GAGG;AACI,MAAM,6BAA6B,GAAG,GAAG,EAAE;IAC9C,OAAO,oBAAW,KAAK,MAAM;QACzB,CAAC,CAAC,mCAAmC;QACrC,CAAC,CAAC,kCAAkC,CAAC;AAC7C,CAAC,CAAC;AAJW,QAAA,6BAA6B,iCAIxC;AAEF;;;GAGG;AACI,MAAM,qCAAqC,GAAG,GAAG,EAAE;IACtD,OAAO,oBAAW,KAAK,MAAM;QACzB,CAAC,CAAC,wCAAwC;QAC1C,CAAC,CAAC,uCAAuC,CAAC;AAClD,CAAC,CAAC;AAJW,QAAA,qCAAqC,yCAIhD"}

package/dist/services/custom-terms/customTerms.d.ts

@@ -0,0 +1,229 @@
+import { AddFeaturesResponse } from '../shared/addFeatures';
+import { ApplyEditsResult } from '../shared/applyEdits';
+import { CustomTermCategory, CustomTermStatus } from '../shared/config';
+import { ItemInfoResponse } from '../shared/getItemInfo';
+import { CustomTermsFeatureTableField } from './config';
+/**
+ * Custom term feature from the feature table
+ */
+export type CustomTermFeature = {
+    /**
+     * objectId of the feature
+     */
+    objectId: number;
+    /**
+     * the term that is added by the user
+     */
+    term: string;
+    /**
+     * the category of the term
+     */
+    category: CustomTermCategory;
+    /**
+     * the status of the term
+     */
+    status: CustomTermStatus;
+    /**
+     * title of the item that the term is added to,
+     * this is used to provide context to the term
+     * when it is reviewed by the Living Atlas team
+     */
+    title: string;
+    /**
+     * snippet of the item that the term is added to,
+     * this is used to provide context to the term
+     * when it is reviewed by the Living Atlas team
+     */
+    snippet: string;
+    /**
+     * itemId of the item that the term is added to,
+     */
+    itemId: string;
+    /**
+     * note of this term
+     */
+    note: string;
+    /**
+     * date when the term was created
+     */
+    creationDate: number;
+    /**
+     * date when the term was last modified
+     */
+    modifiedDate: number;
+    /**
+     * the user who created the term
+     */
+    creator: string;
+    /**
+     * the user who edited the term
+     */
+    editor: string;
+};
+type GetCustomTermsOptions = {
+    /**
+     * The user IDs to filter the custom terms by creator.
+     */
+    userIds: string[];
+    /**
+     * The authentication token.
+     */
+    token: string;
+    /**
+     * The status filter for the custom terms.
+     */
+    status?: CustomTermStatus[];
+    /**
+     * The fields to include in the response.
+     */
+    fields?: CustomTermsFeatureTableField[];
+    /**
+     * The maximum number of records to return.
+     * If set, the function will stop fetching more records once this limit is reached.
+     * If not set, the function will fetch all records.
+     */
+    maxNumOfRecords?: number;
+    /**
+     * The offset for the result set.
+     */
+    resultOffset?: number;
+};
+/**
+ * Fetches custom terms from the Custom Terms Feature Table based on the provided options.
+ *
+ * @param {Object} options - The options for fetching custom terms.
+ * @param {string} options.token - The authentication token.
+ * @param {string[]} [options.status] - The status filter for the custom terms.
+ * @param {string[]} options.userIds - The user IDs to filter the custom terms by creator.
+ * @param {string[]} [options.fields] - The fields to include in the response.
+ *
+ * @returns {Promise<CustomTermFeature[]>} A promise that resolves to an array of custom term features.
+ *
+ * @throws Will throw an error if the response contains an error.
+ */
+export declare const getCustomTerms: ({ token, status, userIds, fields, maxNumOfRecords, resultOffset, }: GetCustomTermsOptions) => Promise<CustomTermFeature[]>;
+/**
+ * Retrieves the count of custom terms based on the provided criteria.
+ *
+ * @param {Object} params - The parameters for the request.
+ * @param {string} params.token - The authentication token.
+ * @param {CustomTermStatus[]} [params.status] - Optional array of custom term statuses to filter by.
+ * @param {string[]} params.userIds - Array of user IDs to filter by.
+ *
+ * @returns {Promise<number>} - A promise that resolves to the count of custom terms.
+ */
+export declare const getCountOfCustomTerms: ({ token, status, userIds, }: {
+    token: string;
+    status?: CustomTermStatus[];
+    userIds: string[];
+}) => Promise<number>;
+/**
+ * Retrieves the custom terms that have been submitted by users for review.
+ * The custom terms have a status of 'submitted' meaning they are **pending review** by the Living Atlas team.
+ *
+ * @param {Object} params - The parameters for retrieving submitted custom terms.
+ * @param {string[]} [params.userIds] - Optional array of user IDs to filter the custom terms.
+ * @param {boolean} [params.shouldIncludeAllFields=false] - Flag indicating whether to include all fields in the response.
+ * @param {string} params.token - The authentication token required to access the custom terms.
+ * @returns {Promise<CustomTermFeature[]>} A promise that resolves to an array of submitted custom term features.
+ */
+export declare const getSubmittedCustomTerms: ({ userIds, shouldIncludeAllFields, token, }: {
+    userIds?: string[];
+    shouldIncludeAllFields?: boolean;
+    token: string;
+}) => Promise<CustomTermFeature[]>;
+/**
+ * Get custom terms that are added by the signed-in user.
+ *
+ * @param userId id of the user
+ * @param token authentication token
+ * @returns Promise<CustomTermFeature[]> array of custom term features that are added by the signed-in user.
+ */
+export declare const getMyCustomTerms: ({ userId, token, maxNumOfRecords, resultOffset, }: {
+    userId: string;
+    token: string;
+    maxNumOfRecords?: number;
+    resultOffset?: number;
+}) => Promise<CustomTermFeature[]>;
+/**
+ * Get the count of custom terms that are added by the signed-in user.
+ *
+ * @param userId id of the user
+ * @param token authentication token
+ * @returns Promise<number> count of custom terms that are added by the signed-in user.
+ */
+export declare const getCountOfMyCustomTerms: (userId: string, token: string) => Promise<number>;
+/**
+ * Add custom term to the feature table for the Living Atlas team to review
+ *
+ * @param customTermFeature - The custom term feature to be added.
+ * @param token - The authentication token.
+ * @returns A promise that resolves to an array of `AddCustomTermFeatureResponse` objects.
+ *
+ * @remark
+ * Here is an example of a failed request with `rollbackOnFailure`. This is caused by the second feature containing invalid data for the `item_id` field.
+ *
+ * ```
+ * {
+ *   "addResults" : [
+ *     {
+ *       "objectId" : 1010,
+ *       "uniqueId" : 1010,
+ *       "globalId" : "1F68",
+ *       "success" : false,
+ *       "error" : {
+ *         "code" : 1003,
+ *         "description" : "Operation rolled back."
+ *       }
+ *     },
+ *     {
+ *       "objectId" : -1,
+ *       "uniqueId" : -1,
+ *       "globalId" : "AE186",
+ *       "success" : false,
+ *       "error" : {
+ *         "code" : 1000,
+ *         "description" : "String or binary data would be truncated.\r\nThe statement has been terminated."
+ *       }
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const addCustomTerms2FeatureTable: (data: {
+    term: string;
+    category: CustomTermCategory;
+    title: string;
+    snippet: string;
+    itemId: string;
+}[], token: string) => Promise<AddFeaturesResponse[]>;
+/**
+ * Updates the status of custom terms in the feature table.
+ *
+ * @param token - The authentication token required for the operation
+ * @param data - An array of objects containing:
+ *   - objectId: The unique identifier of the custom term
+ *   - status: The decision made by the Living Atlas team about the term
+ *   - note: A comment/note left by the Living Atlas team
+ *
+ * @throws {Error} If token is missing, required fields are not provided, or other operation errors occur
+ * @returns A promise that resolves to an array of ApplyEditsResult objects
+ */
+export declare const updateStatusOfCustomTermsInFeatureTable: (token: string, data: {
+    objectId: number;
+    /**
+     * the status of the term, which is the decision made by the Living Atlas team
+     */
+    status: CustomTermStatus;
+    /**
+     * note/comment left by the Living Atlas team
+     */
+    note: string;
+}[]) => Promise<ApplyEditsResult[]>;
+/**
+ * Get the item info for the Custom Terms feature table.
+ * @param token - The authentication token required to access the item info.
+ * @returns A promise that resolves to an `ItemInfoResponse` object containing metadata about the feature table.
+ */
+export declare const getCustomTermsFeatureTableItemInfo: (token: string) => Promise<ItemInfoResponse>;
+export {};