@dremio/js-sdk 0.1.0

package/dist/oss/catalog/CatalogReferences/utils/catalogReferenceFromProperties.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DatasetCatalogReference } from "../DatasetCatalogReference.js";
+import { FileCatalogReference } from "../FileCatalogReference.js";
+import { FolderCatalogReference } from "../FolderCatalogReference.js";
+import { FunctionCatalogReference } from "../FunctionCatalogReference.js";
+import { HomeCatalogReference } from "../HomeCatalogReference.js";
+import { SourceCatalogReference } from "../SourceCatalogReference.js";
+import { SpaceCatalogReference } from "../SpaceCatalogReference.js";
+export const catalogReferenceFromProperties = (properties, config, retrieveByPath) => {
+    switch (properties.type) {
+        case "DATASET_DIRECT":
+        case "DATASET_PROMOTED":
+        case "DATASET_VIRTUAL":
+            return new DatasetCatalogReference(properties, retrieveByPath, config);
+        case "FILE":
+            return new FileCatalogReference(properties, retrieveByPath);
+        case "FOLDER":
+            return new FolderCatalogReference(properties, config, retrieveByPath);
+        case "FUNCTION":
+            return new FunctionCatalogReference(properties, retrieveByPath);
+        case "HOME":
+            return new HomeCatalogReference(properties, config, retrieveByPath);
+        case "SOURCE":
+            return new SourceCatalogReference(properties, config, retrieveByPath);
+        case "SPACE":
+            return new SpaceCatalogReference(properties, config, retrieveByPath);
+        default:
+            throw new Error("Unknown catalogReference type: " + properties.type);
+    }
+};
+//# sourceMappingURL=catalogReferenceFromProperties.js.map

package/dist/oss/catalog/CatalogReferences/utils/catalogReferenceFromProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogReferenceFromProperties.js","sourceRoot":"","sources":["../../../../../src/oss/catalog/CatalogReferences/utils/catalogReferenceFromProperties.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,UAA6D,EAC7D,MAAqB,EACrB,cAA8B,EACZ,EAAE;IACpB,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,gBAAgB,CAAC;QACtB,KAAK,kBAAkB,CAAC;QACxB,KAAK,iBAAiB;YACpB,OAAO,IAAI,uBAAuB,CAAC,UAAiB,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;QAChF,KAAK,MAAM;YACT,OAAO,IAAI,oBAAoB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC9D,KAAK,QAAQ;YACX,OAAO,IAAI,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QACxE,KAAK,UAAU;YACb,OAAO,IAAI,wBAAwB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAClE,KAAK,MAAM;YACT,OAAO,IAAI,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QACtE,KAAK,QAAQ;YACX,OAAO,IAAI,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QACxE,KAAK,OAAO;YACV,OAAO,IAAI,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QACvE;YACE,MAAM,IAAI,KAAK,CAAC,iCAAiC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;AACH,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SonarV3Config } from \"../../../../common/Config.ts\";\nimport type { BaseCatalogReferenceProperties, RetrieveByPath } from \"../BaseCatalogReference.ts\";\nimport { DatasetCatalogReference } from \"../DatasetCatalogReference.ts\";\nimport { FileCatalogReference } from \"../FileCatalogReference.ts\";\nimport { FolderCatalogReference } from \"../FolderCatalogReference.ts\";\nimport { FunctionCatalogReference } from \"../FunctionCatalogReference.ts\";\nimport { HomeCatalogReference } from \"../HomeCatalogReference.ts\";\nimport { SourceCatalogReference } from \"../SourceCatalogReference.ts\";\nimport { SpaceCatalogReference } from \"../SpaceCatalogReference.ts\";\nimport type { CatalogReference } from \"../index.ts\";\n\nexport const catalogReferenceFromProperties = (\n  properties: BaseCatalogReferenceProperties & { type: string },\n  config: SonarV3Config,\n  retrieveByPath: RetrieveByPath,\n): CatalogReference => {\n  switch (properties.type) {\n    case \"DATASET_DIRECT\":\n    case \"DATASET_PROMOTED\":\n    case \"DATASET_VIRTUAL\":\n      return new DatasetCatalogReference(properties as any, retrieveByPath, config);\n    case \"FILE\":\n      return new FileCatalogReference(properties, retrieveByPath);\n    case \"FOLDER\":\n      return new FolderCatalogReference(properties, config, retrieveByPath);\n    case \"FUNCTION\":\n      return new FunctionCatalogReference(properties, retrieveByPath);\n    case \"HOME\":\n      return new HomeCatalogReference(properties, config, retrieveByPath);\n    case \"SOURCE\":\n      return new SourceCatalogReference(properties, config, retrieveByPath);\n    case \"SPACE\":\n      return new SpaceCatalogReference(properties, config, retrieveByPath);\n    default:\n      throw new Error(\"Unknown catalogReference type: \" + properties.type);\n  }\n};\n"]}

package/dist/oss/catalog/CatalogReferences/utils/getTags.d.ts

@@ -0,0 +1,5 @@
+import { Err, Ok } from "ts-results-es";
+import type { SonarV3Config } from "../../../../common/Config.ts";
+import { CatalogTags } from "../../CatalogTags.ts";
+import type { CatalogReference } from "../index.ts";
+export declare const getTags: (config: SonarV3Config, catalogReference: CatalogReference) => () => Promise<Err<unknown> | Ok<CatalogTags>>;

package/dist/oss/catalog/CatalogReferences/utils/getTags.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Err, Ok } from "ts-results-es";
+import { CatalogTags, catalogTagsEntityToProperties } from "../../CatalogTags.js";
+export const getTags = (config, catalogReference) => () => config
+    .sonarV3Request(`catalog/${catalogReference.id}/collaboration/tag`)
+    .then((res) => res.json())
+    .then((entity) => Ok(new CatalogTags(catalogTagsEntityToProperties(catalogReference, entity), config)))
+    .catch((e) => Err(e));
+//# sourceMappingURL=getTags.js.map

package/dist/oss/catalog/CatalogReferences/utils/getTags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTags.js","sourceRoot":"","sources":["../../../../../src/oss/catalog/CatalogReferences/utils/getTags.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAGlF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAqB,EAAE,gBAAkC,EAAE,EAAE,CAAC,GAAG,EAAE,CACzF,MAAM;KACH,cAAc,CAAC,WAAW,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;KAClE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;KACzB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACf,EAAE,CAAC,IAAI,WAAW,CAAC,6BAA6B,CAAC,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CACrF;KACA,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Err, Ok } from \"ts-results-es\";\nimport type { SonarV3Config } from \"../../../../common/Config.ts\";\nimport { CatalogTags, catalogTagsEntityToProperties } from \"../../CatalogTags.ts\";\nimport type { CatalogReference } from \"../index.ts\";\n\nexport const getTags = (config: SonarV3Config, catalogReference: CatalogReference) => () =>\n  config\n    .sonarV3Request(`catalog/${catalogReference.id}/collaboration/tag`)\n    .then((res) => res.json())\n    .then((entity) =>\n      Ok(new CatalogTags(catalogTagsEntityToProperties(catalogReference, entity), config)),\n    )\n    .catch((e: unknown) => Err(e));\n"]}

package/dist/oss/catalog/CatalogReferences/utils/getWiki.d.ts

@@ -0,0 +1,5 @@
+import { Err, Ok } from "ts-results-es";
+import type { SonarV3Config } from "../../../../common/Config.ts";
+import { CatalogWiki } from "../../CatalogWiki.ts";
+import type { CatalogReference } from "../index.ts";
+export declare const getWiki: (config: SonarV3Config, catalogReference: CatalogReference) => () => Promise<Err<unknown> | Ok<CatalogWiki>>;

package/dist/oss/catalog/CatalogReferences/utils/getWiki.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Err, Ok } from "ts-results-es";
+import { CatalogWiki, catalogWikiEntityToProperties } from "../../CatalogWiki.js";
+export const getWiki = (config, catalogReference) => () => config
+    .sonarV3Request(`catalog/${catalogReference.id}/collaboration/wiki`)
+    .then((res) => res.json())
+    .then((entity) => Ok(new CatalogWiki(catalogWikiEntityToProperties(catalogReference, entity), config)))
+    .catch((e) => Err(e));
+//# sourceMappingURL=getWiki.js.map

package/dist/oss/catalog/CatalogReferences/utils/getWiki.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWiki.js","sourceRoot":"","sources":["../../../../../src/oss/catalog/CatalogReferences/utils/getWiki.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAGlF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAqB,EAAE,gBAAkC,EAAE,EAAE,CAAC,GAAG,EAAE,CACzF,MAAM;KACH,cAAc,CAAC,WAAW,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;KACnE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;KACzB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACf,EAAE,CAAC,IAAI,WAAW,CAAC,6BAA6B,CAAC,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CACrF;KACA,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Err, Ok } from \"ts-results-es\";\nimport type { SonarV3Config } from \"../../../../common/Config.ts\";\nimport { CatalogWiki, catalogWikiEntityToProperties } from \"../../CatalogWiki.ts\";\nimport type { CatalogReference } from \"../index.ts\";\n\nexport const getWiki = (config: SonarV3Config, catalogReference: CatalogReference) => () =>\n  config\n    .sonarV3Request(`catalog/${catalogReference.id}/collaboration/wiki`)\n    .then((res) => res.json())\n    .then((entity) =>\n      Ok(new CatalogWiki(catalogWikiEntityToProperties(catalogReference, entity), config)),\n    )\n    .catch((e: unknown) => Err(e));\n"]}

package/dist/oss/catalog/CatalogResource.d.ts

@@ -0,0 +1,10 @@
+import type { SonarV3Config } from "../../common/Config.ts";
+import type { FunctionCatalogReference, HomeCatalogReference, SourceCatalogReference, SpaceCatalogReference } from "./CatalogReferences/index.ts";
+export declare const CatalogResource: (config: SonarV3Config) => {
+    _catalogReferenceFromEntity: (entity: unknown) => import("./CatalogReferences/index.ts").CatalogReference;
+    list: () => {
+        data(): AsyncGenerator<FunctionCatalogReference | HomeCatalogReference | SourceCatalogReference | SpaceCatalogReference, void, unknown>;
+    };
+    retrieve: (key: string) => Promise<import("ts-results-es").Result<import("./CatalogObjects/index.ts").CatalogObject, import("../index.ts").Problem>>;
+    retrieveByPath: (key: string[]) => Promise<import("ts-results-es").Result<import("./CatalogObjects/index.ts").CatalogObject, import("../index.ts").Problem>>;
+};

package/dist/oss/catalog/CatalogResource.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { catalogReferenceEntityToProperties } from "./CatalogReferences/utils/catalogReferenceEntityToProperties.js";
+import { catalogReferenceFromProperties } from "./CatalogReferences/utils/catalogReferenceFromProperties.js";
+import { baseRetrieve, baseRetrieveByPath } from "./catalogRetrieve.js";
+export const CatalogResource = (config) => {
+    const retrieve = baseRetrieve(config);
+    const retrieveByPath = baseRetrieveByPath(config);
+    return {
+        _catalogReferenceFromEntity: (entity) => catalogReferenceFromProperties(catalogReferenceEntityToProperties(entity), config, retrieveByPath),
+        list: () => {
+            return {
+                async *data() {
+                    yield* await config
+                        .sonarV3Request("catalog")
+                        .then((res) => res.json())
+                        .then((response) => response.data.map((entity) => catalogReferenceFromProperties(catalogReferenceEntityToProperties(entity), config, retrieveByPath)));
+                },
+            };
+        },
+        retrieve,
+        retrieveByPath,
+    };
+};
+//# sourceMappingURL=CatalogResource.js.map

package/dist/oss/catalog/CatalogResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogResource.js","sourceRoot":"","sources":["../../../src/oss/catalog/CatalogResource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AASH,OAAO,EAAE,kCAAkC,EAAE,MAAM,iEAAiE,CAAC;AACrH,OAAO,EAAE,8BAA8B,EAAE,MAAM,6DAA6D,CAAC;AAC7G,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAExE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAqB,EAAE,EAAE;IACvD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAElD,OAAO;QACL,2BAA2B,EAAE,CAAC,MAAe,EAAE,EAAE,CAC/C,8BAA8B,CAC5B,kCAAkC,CAAC,MAAM,CAAC,EAC1C,MAAM,EACN,cAAc,CACf;QACH,IAAI,EAAE,GAAG,EAAE;YACT,OAAO;gBACL,KAAK,CAAC,CAAC,IAAI;oBACT,KAAK,CAAC,CAAC,MAAM,MAAM;yBAChB,cAAc,CAAC,SAAS,CAAC;yBACzB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;yBACzB,IAAI,CAAC,CAAC,QAA6B,EAAE,EAAE,CACtC,QAAQ,CAAC,IAAI,CAAC,GAAG,CACf,CAAC,MAAe,EAAE,EAAE,CAClB,8BAA8B,CAC5B,kCAAkC,CAAC,MAAM,CAAC,EAC1C,MAAM,EACN,cAAc,CAKS,CAC5B,CACF,CAAC;gBACN,CAAC;aACF,CAAC;QACJ,CAAC;QACD,QAAQ;QACR,cAAc;KACf,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport type {\n  FunctionCatalogReference,\n  HomeCatalogReference,\n  SourceCatalogReference,\n  SpaceCatalogReference,\n} from \"./CatalogReferences/index.ts\";\nimport { catalogReferenceEntityToProperties } from \"./CatalogReferences/utils/catalogReferenceEntityToProperties.ts\";\nimport { catalogReferenceFromProperties } from \"./CatalogReferences/utils/catalogReferenceFromProperties.ts\";\nimport { baseRetrieve, baseRetrieveByPath } from \"./catalogRetrieve.ts\";\n\nexport const CatalogResource = (config: SonarV3Config) => {\n  const retrieve = baseRetrieve(config);\n  const retrieveByPath = baseRetrieveByPath(config);\n\n  return {\n    _catalogReferenceFromEntity: (entity: unknown) =>\n      catalogReferenceFromProperties(\n        catalogReferenceEntityToProperties(entity),\n        config,\n        retrieveByPath,\n      ),\n    list: () => {\n      return {\n        async *data() {\n          yield* await config\n            .sonarV3Request(\"catalog\")\n            .then((res) => res.json())\n            .then((response: { data: unknown[] }) =>\n              response.data.map(\n                (entity: unknown) =>\n                  catalogReferenceFromProperties(\n                    catalogReferenceEntityToProperties(entity),\n                    config,\n                    retrieveByPath,\n                  ) as\n                    | FunctionCatalogReference\n                    | HomeCatalogReference\n                    | SourceCatalogReference\n                    | SpaceCatalogReference,\n              ),\n            );\n        },\n      };\n    },\n    retrieve,\n    retrieveByPath,\n  };\n};\n"]}

package/dist/oss/catalog/CatalogTags.d.ts

@@ -0,0 +1,26 @@
+import { Err, Ok } from "ts-results-es";
+import type { SonarV3Config } from "../../common/Config.ts";
+import type { CatalogReference } from "../interfaces.ts";
+import { HttpError } from "../../common/HttpError.ts";
+export declare class CatalogTags {
+    #private;
+    readonly catalogReference: CatalogReference;
+    readonly tags: string[];
+    constructor(properties: CatalogTagsProperties, config: SonarV3Config);
+    update(properties: {
+        tags: string[];
+    }): Promise<Err<{
+        readonly title: "The version of the provided resource is older than the stored version";
+        readonly type: "https://api.dremio.dev/problems/version-conflict";
+    }> | Err<HttpError> | Ok<CatalogTags>>;
+}
+export declare const catalogTagsEntityToProperties: (catalogReference: CatalogReference, entity: {
+    tags: string[];
+    version: number;
+}) => {
+    catalogReference: CatalogReference;
+    tags: string[];
+    version: number;
+};
+type CatalogTagsProperties = ReturnType<typeof catalogTagsEntityToProperties>;
+export {};

package/dist/oss/catalog/CatalogTags.js

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Err, Ok } from "ts-results-es";
+import { HttpError } from "../../common/HttpError.js";
+import { versionConflictError } from "../../common/problems.js";
+export class CatalogTags {
+    catalogReference;
+    tags;
+    #version;
+    #config;
+    constructor(properties, config) {
+        this.catalogReference = properties.catalogReference;
+        this.tags = properties.tags;
+        this.#version = properties.version;
+        this.#config = config;
+    }
+    update(properties) {
+        return this.#config
+            .sonarV3Request(`catalog/${this.catalogReference.id}/collaboration/tag`, {
+            body: JSON.stringify({
+                tags: properties.tags,
+                version: this.#version,
+            }),
+            headers: {
+                "Content-Type": "application/json",
+            },
+            keepalive: true,
+            method: "POST",
+        })
+            .then((res) => res.json())
+            .then((entity) => Ok(new CatalogTags(catalogTagsEntityToProperties(this.catalogReference, entity), this.#config)))
+            .catch((e) => {
+            if (e instanceof HttpError) {
+                if (e.status === 409) {
+                    return Err(versionConflictError);
+                }
+                return Err(e);
+            }
+            throw e;
+        });
+    }
+}
+export const catalogTagsEntityToProperties = (catalogReference, entity) => ({
+    ...entity,
+    catalogReference,
+});
+//# sourceMappingURL=CatalogTags.js.map

package/dist/oss/catalog/CatalogTags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogTags.js","sourceRoot":"","sources":["../../../src/oss/catalog/CatalogTags.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,MAAM,OAAO,WAAW;IACb,gBAAgB,CAAmB;IACnC,IAAI,CAAW;IAExB,QAAQ,CAAmC;IAC3C,OAAO,CAAgB;IAEvB,YAAY,UAAiC,EAAE,MAAqB;QAClE,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,UAA8B;QACnC,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,WAAW,IAAI,CAAC,gBAAgB,CAAC,EAAE,oBAAoB,EAAE;YACvE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,OAAO,EAAE,IAAI,CAAC,QAAQ;aACvB,CAAC;YACF,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,MAAM;SACf,CAAC;aACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;aACzB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACf,EAAE,CACA,IAAI,WAAW,CACb,6BAA6B,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,EAC5D,IAAI,CAAC,OAAO,CACb,CACF,CACF;aACA,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;YACpB,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBACrB,OAAO,GAAG,CAAC,oBAAoB,CAAC,CAAC;gBACnC,CAAC;gBACD,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;YAChB,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACP,CAAC;CACF;AAED,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,gBAAkC,EAClC,MAGC,EACD,EAAE,CAAC,CAAC;IACJ,GAAG,MAAM;IACT,gBAAgB;CACjB,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Err, Ok } from \"ts-results-es\";\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport type { CatalogReference } from \"../interfaces.ts\";\nimport { HttpError } from \"../../common/HttpError.ts\";\nimport { versionConflictError } from \"../../common/problems.ts\";\n\nexport class CatalogTags {\n  readonly catalogReference: CatalogReference;\n  readonly tags: string[];\n\n  #version: CatalogTagsProperties[\"version\"];\n  #config: SonarV3Config;\n\n  constructor(properties: CatalogTagsProperties, config: SonarV3Config) {\n    this.catalogReference = properties.catalogReference;\n    this.tags = properties.tags;\n    this.#version = properties.version;\n    this.#config = config;\n  }\n\n  update(properties: { tags: string[] }) {\n    return this.#config\n      .sonarV3Request(`catalog/${this.catalogReference.id}/collaboration/tag`, {\n        body: JSON.stringify({\n          tags: properties.tags,\n          version: this.#version,\n        }),\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n        keepalive: true,\n        method: \"POST\",\n      })\n      .then((res) => res.json())\n      .then((entity) =>\n        Ok(\n          new CatalogTags(\n            catalogTagsEntityToProperties(this.catalogReference, entity),\n            this.#config,\n          ),\n        ),\n      )\n      .catch((e: unknown) => {\n        if (e instanceof HttpError) {\n          if (e.status === 409) {\n            return Err(versionConflictError);\n          }\n          return Err(e);\n        }\n        throw e;\n      });\n  }\n}\n\nexport const catalogTagsEntityToProperties = (\n  catalogReference: CatalogReference,\n  entity: {\n    tags: string[];\n    version: number;\n  },\n) => ({\n  ...entity,\n  catalogReference,\n});\n\ntype CatalogTagsProperties = ReturnType<typeof catalogTagsEntityToProperties>;\n"]}

package/dist/oss/catalog/CatalogWiki.d.ts

@@ -0,0 +1,26 @@
+import { Err, Ok } from "ts-results-es";
+import type { SonarV3Config } from "../../common/Config.ts";
+import type { CatalogReference } from "../interfaces.ts";
+import { HttpError } from "../../common/HttpError.ts";
+export declare class CatalogWiki {
+    #private;
+    readonly catalogReference: CatalogReference;
+    readonly text: CatalogWikiProperties["text"];
+    constructor(properties: CatalogWikiProperties, config: SonarV3Config);
+    update(properties: {
+        text: string;
+    }): Promise<Ok<CatalogWiki> | Err<{
+        readonly title: "The version of the provided resource is older than the stored version";
+        readonly type: "https://api.dremio.dev/problems/version-conflict";
+    }> | Err<HttpError>>;
+}
+export declare const catalogWikiEntityToProperties: (catalogReference: CatalogReference, entity: {
+    text: string;
+    version: number;
+}) => {
+    catalogReference: CatalogReference;
+    text: string;
+    version: number;
+};
+type CatalogWikiProperties = ReturnType<typeof catalogWikiEntityToProperties>;
+export {};

package/dist/oss/catalog/CatalogWiki.js

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Err, Ok } from "ts-results-es";
+import { HttpError } from "../../common/HttpError.js";
+import { versionConflictError } from "../../common/problems.js";
+export class CatalogWiki {
+    catalogReference;
+    text;
+    #version;
+    #config;
+    constructor(properties, config) {
+        this.catalogReference = properties.catalogReference;
+        this.text = properties.text;
+        this.#version = properties.version;
+        this.#config = config;
+    }
+    update(properties) {
+        return this.#config
+            .sonarV3Request(`catalog/${this.catalogReference.id}/collaboration/wiki`, {
+            body: JSON.stringify({
+                text: properties.text,
+                version: this.#version,
+            }),
+            headers: {
+                "Content-Type": "application/json",
+            },
+            keepalive: true,
+            method: "POST",
+        })
+            .then((res) => res.json())
+            .then((entity) => Ok(new CatalogWiki(catalogWikiEntityToProperties(this.catalogReference, entity), this.#config)))
+            .catch((e) => {
+            if (e instanceof HttpError) {
+                if (e.status === 409) {
+                    return Err(versionConflictError);
+                }
+                return Err(e);
+            }
+            throw e;
+        });
+    }
+}
+export const catalogWikiEntityToProperties = (catalogReference, entity) => ({
+    ...entity,
+    catalogReference,
+});
+//# sourceMappingURL=CatalogWiki.js.map

package/dist/oss/catalog/CatalogWiki.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogWiki.js","sourceRoot":"","sources":["../../../src/oss/catalog/CatalogWiki.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,MAAM,OAAO,WAAW;IACb,gBAAgB,CAAmB;IACnC,IAAI,CAAgC;IAE7C,QAAQ,CAAmC;IAC3C,OAAO,CAAgB;IAEvB,YAAY,UAAiC,EAAE,MAAqB;QAClE,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,UAA4B;QACjC,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,WAAW,IAAI,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,EAAE;YACxE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,OAAO,EAAE,IAAI,CAAC,QAAQ;aACvB,CAAC;YACF,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,MAAM;SACf,CAAC;aACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;aACzB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACf,EAAE,CACA,IAAI,WAAW,CACb,6BAA6B,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,EAC5D,IAAI,CAAC,OAAO,CACb,CACF,CACF;aACA,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;YACpB,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBACrB,OAAO,GAAG,CAAC,oBAAoB,CAAC,CAAC;gBACnC,CAAC;gBACD,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;YAChB,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACP,CAAC;CACF;AAED,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,gBAAkC,EAClC,MAGC,EACD,EAAE,CAAC,CAAC;IACJ,GAAG,MAAM;IACT,gBAAgB;CACjB,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Err, Ok } from \"ts-results-es\";\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport type { CatalogReference } from \"../interfaces.ts\";\nimport { HttpError } from \"../../common/HttpError.ts\";\nimport { versionConflictError } from \"../../common/problems.ts\";\n\nexport class CatalogWiki {\n  readonly catalogReference: CatalogReference;\n  readonly text: CatalogWikiProperties[\"text\"];\n\n  #version: CatalogWikiProperties[\"version\"];\n  #config: SonarV3Config;\n\n  constructor(properties: CatalogWikiProperties, config: SonarV3Config) {\n    this.catalogReference = properties.catalogReference;\n    this.text = properties.text;\n    this.#version = properties.version;\n    this.#config = config;\n  }\n\n  update(properties: { text: string }) {\n    return this.#config\n      .sonarV3Request(`catalog/${this.catalogReference.id}/collaboration/wiki`, {\n        body: JSON.stringify({\n          text: properties.text,\n          version: this.#version,\n        }),\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n        keepalive: true,\n        method: \"POST\",\n      })\n      .then((res) => res.json())\n      .then((entity) =>\n        Ok(\n          new CatalogWiki(\n            catalogWikiEntityToProperties(this.catalogReference, entity),\n            this.#config,\n          ),\n        ),\n      )\n      .catch((e: unknown) => {\n        if (e instanceof HttpError) {\n          if (e.status === 409) {\n            return Err(versionConflictError);\n          }\n          return Err(e);\n        }\n        throw e;\n      });\n  }\n}\n\nexport const catalogWikiEntityToProperties = (\n  catalogReference: CatalogReference,\n  entity: {\n    text: string;\n    version: number;\n  },\n) => ({\n  ...entity,\n  catalogReference,\n});\n\ntype CatalogWikiProperties = ReturnType<typeof catalogWikiEntityToProperties>;\n"]}

package/dist/oss/catalog/VersionReference.d.ts

@@ -0,0 +1,13 @@
+export type BranchHeadVersionReference = {
+    branch: string;
+};
+export type BareCommitVersionReference = {
+    hash: string;
+};
+export type TagVersionReference = {
+    tag: string;
+};
+export type VersionReference = BareCommitVersionReference | BranchHeadVersionReference | TagVersionReference;
+export declare const isBranchHeadVersionReference: (versionReference: VersionReference) => versionReference is BranchHeadVersionReference;
+export declare const isBareCommitVersionReference: (versionReference: VersionReference) => versionReference is BareCommitVersionReference;
+export declare const isTagVersionReference: (versionReference: VersionReference) => versionReference is TagVersionReference;

package/dist/oss/catalog/VersionReference.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export const isBranchHeadVersionReference = (versionReference) => !("hash" in versionReference) && "branch" in versionReference;
+export const isBareCommitVersionReference = (versionReference) => "hash" in versionReference && !("branch" in versionReference);
+export const isTagVersionReference = (versionReference) => "tag" in versionReference;
+//# sourceMappingURL=VersionReference.js.map

package/dist/oss/catalog/VersionReference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VersionReference.js","sourceRoot":"","sources":["../../../src/oss/catalog/VersionReference.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAmBH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,gBAAkC,EACc,EAAE,CAClD,CAAC,CAAC,MAAM,IAAI,gBAAgB,CAAC,IAAI,QAAQ,IAAI,gBAAgB,CAAC;AAEhE,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,gBAAkC,EACc,EAAE,CAClD,MAAM,IAAI,gBAAgB,IAAI,CAAC,CAAC,QAAQ,IAAI,gBAAgB,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,gBAAkC,EACO,EAAE,CAAC,KAAK,IAAI,gBAAgB,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type BranchHeadVersionReference = {\n  branch: string;\n};\n\nexport type BareCommitVersionReference = {\n  hash: string;\n};\n\nexport type TagVersionReference = {\n  tag: string;\n};\n\nexport type VersionReference =\n  | BareCommitVersionReference\n  | BranchHeadVersionReference\n  | TagVersionReference;\n\nexport const isBranchHeadVersionReference = (\n  versionReference: VersionReference,\n): versionReference is BranchHeadVersionReference =>\n  !(\"hash\" in versionReference) && \"branch\" in versionReference;\n\nexport const isBareCommitVersionReference = (\n  versionReference: VersionReference,\n): versionReference is BareCommitVersionReference =>\n  \"hash\" in versionReference && !(\"branch\" in versionReference);\n\nexport const isTagVersionReference = (\n  versionReference: VersionReference,\n): versionReference is TagVersionReference => \"tag\" in versionReference;\n"]}

package/dist/oss/catalog/catalogErrors.d.ts

@@ -0,0 +1,18 @@
+export declare const emptyPathError: {
+    readonly errors: [{
+        readonly detail: "`path` parameter is required and cannot be empty";
+        readonly pointer: "#/path";
+        readonly type: "https://api.dremio.dev/problems/validation/min-length";
+    }];
+    readonly title: "There was a problem validating the content of the request";
+    readonly type: "https://api.dremio.dev/problems/validation-problem";
+};
+/**
+ * Generic problem for when we don't know what specifically caused the retrieval
+ * to fail.
+ */
+export declare const unableToRetrieveProblem: (internalErrorMessage?: string) => {
+    readonly detail: string | undefined;
+    readonly title: "We were unable to fetch details for this catalog object";
+    readonly type: "https://api.dremio.dev/problems/catalog/failed-to-retrieve";
+};

package/dist/oss/catalog/catalogErrors.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export const emptyPathError = {
+    errors: [
+        {
+            detail: "`path` parameter is required and cannot be empty",
+            pointer: "#/path",
+            type: "https://api.dremio.dev/problems/validation/min-length",
+        },
+    ],
+    title: "There was a problem validating the content of the request",
+    type: "https://api.dremio.dev/problems/validation-problem",
+};
+/**
+ * Generic problem for when we don't know what specifically caused the retrieval
+ * to fail.
+ */
+export const unableToRetrieveProblem = (internalErrorMessage) => ({
+    detail: internalErrorMessage,
+    title: "We were unable to fetch details for this catalog object",
+    type: "https://api.dremio.dev/problems/catalog/failed-to-retrieve",
+});
+//# sourceMappingURL=catalogErrors.js.map

package/dist/oss/catalog/catalogErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogErrors.js","sourceRoot":"","sources":["../../../src/oss/catalog/catalogErrors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE;QACN;YACE,MAAM,EAAE,kDAAkD;YAC1D,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,uDAAuD;SAC9D;KACF;IACD,KAAK,EAAE,2DAA2D;IAClE,IAAI,EAAE,oDAAoD;CACtB,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,oBAA6B,EAAE,EAAE,CACvE,CAAC;IACC,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,yDAAyD;IAChE,IAAI,EAAE,4DAA4D;CACnE,CAA4B,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Problem, ValidationProblem } from \"../../common/Problem.ts\";\n\nexport const emptyPathError = {\n  errors: [\n    {\n      detail: \"`path` parameter is required and cannot be empty\",\n      pointer: \"#/path\",\n      type: \"https://api.dremio.dev/problems/validation/min-length\",\n    },\n  ],\n  title: \"There was a problem validating the content of the request\",\n  type: \"https://api.dremio.dev/problems/validation-problem\",\n} as const satisfies ValidationProblem;\n\n/**\n * Generic problem for when we don't know what specifically caused the retrieval\n * to fail.\n */\nexport const unableToRetrieveProblem = (internalErrorMessage?: string) =>\n  ({\n    detail: internalErrorMessage,\n    title: \"We were unable to fetch details for this catalog object\",\n    type: \"https://api.dremio.dev/problems/catalog/failed-to-retrieve\",\n  }) as const satisfies Problem;\n"]}

package/dist/oss/catalog/catalogRetrieve.d.ts

@@ -0,0 +1,6 @@
+import { type Result } from "ts-results-es";
+import type { SonarV3Config } from "../../common/Config.ts";
+import type { CatalogObject } from "./CatalogObjects/index.ts";
+import type { Problem } from "../../common/Problem.ts";
+export declare const baseRetrieve: (config: SonarV3Config) => (key: string) => Promise<Result<CatalogObject, Problem>>;
+export declare const baseRetrieveByPath: (config: SonarV3Config) => (key: string[]) => Promise<Result<CatalogObject, Problem>>;

package/dist/oss/catalog/catalogRetrieve.js

@@ -0,0 +1,119 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { batch } from "../../common/batch.js";
+import { Err, Ok } from "ts-results-es";
+import { catalogObjectFromEntity } from "./CatalogObjects/utils/catalogObjectFromEntity.js";
+import { HttpError } from "../../common/HttpError.js";
+import { unableToRetrieveProblem } from "./catalogErrors.js";
+export const baseRetrieve = (config) => batch(async (ids) => {
+    const results = new Map();
+    if (ids.size === 1) {
+        const id = Array.from(ids).at(0);
+        return config
+            .sonarV3Request(`catalog/${id}?maxChildren=0`)
+            .then((res) => res.json())
+            .then((response) => {
+            results.set(id, Ok(catalogObjectFromEntity(config, baseRetrieveByPath(config))(response)));
+            return results;
+        })
+            .catch((e) => {
+            if (e instanceof HttpError) {
+                results.set(id, Err(e.body));
+            }
+            else {
+                results.set(id, Err(unableToRetrieveProblem()));
+            }
+            return results;
+        });
+    }
+    const idsArray = Array.from(ids);
+    const chunks = [];
+    while (idsArray.length > 0) {
+        chunks.push(idsArray.splice(0, Math.min(50, idsArray.length)));
+    }
+    const catalogItems = await Promise.all(chunks.map((chunk) => config
+        .sonarV3Request(`catalog/by-ids?maxChildren=0`, {
+        body: JSON.stringify(chunk),
+        headers: { "Content-Type": "application/json" },
+        method: "POST",
+    })
+        .then((res) => res.json())
+        .then((response) => response.data))).then((chunks) => chunks.flat());
+    for (const catalogItem of catalogItems) {
+        results.set(catalogItem.id, Ok(catalogObjectFromEntity(config, baseRetrieveByPath(config))(catalogItem)));
+    }
+    for (const id of ids) {
+        if (!results.has(id)) {
+            results.set(id, Err(unableToRetrieveProblem()));
+        }
+    }
+    return results;
+});
+export const baseRetrieveByPath = (config) => batch(async (paths) => {
+    const results = new Map();
+    // Because the key is a reference type (array), we need to store the
+    // original path reference
+    const originalKeyRef = new Map();
+    for (const key of paths) {
+        originalKeyRef.set(JSON.stringify(key), key);
+    }
+    if (paths.size === 1) {
+        const path = Array.from(paths).at(0);
+        return config
+            .sonarV3Request(`catalog/by-path/${path.map(encodeURIComponent).join("/")}?maxChildren=0`)
+            .then((res) => res.json())
+            .then((response) => {
+            results.set(path, Ok(catalogObjectFromEntity(config, baseRetrieveByPath(config))(response)));
+            return results;
+        })
+            .catch((e) => {
+            if (e instanceof HttpError) {
+                results.set(path, Err(e.body));
+            }
+            else {
+                results.set(path, Err(unableToRetrieveProblem()));
+            }
+            return results;
+        });
+    }
+    const pathsArray = Array.from(paths);
+    const chunks = [];
+    while (pathsArray.length > 0) {
+        chunks.push(pathsArray.splice(0, Math.min(50, pathsArray.length)));
+    }
+    const catalogItems = await Promise.all(chunks.map((chunk) => config
+        .sonarV3Request(`catalog/by-paths?maxChildren=0`, {
+        body: JSON.stringify(chunk),
+        headers: { "Content-Type": "application/json" },
+        method: "POST",
+    })
+        .then((res) => res.json())
+        .then((response) => response.data))).then((chunks) => chunks.flat());
+    for (const catalogItem of catalogItems) {
+        const resolved = catalogObjectFromEntity(config, baseRetrieveByPath(config))(catalogItem);
+        const originalKey = originalKeyRef.get(JSON.stringify(resolved.path));
+        if (originalKey) {
+            results.set(originalKey, Ok(resolved));
+        }
+    }
+    for (const path of paths) {
+        if (!results.has(path)) {
+            results.set(path, Err(unableToRetrieveProblem()));
+        }
+    }
+    return results;
+});
+//# sourceMappingURL=catalogRetrieve.js.map