@osdk/internal.foundry.datasets 0.0.0

package/build/types/public/File.d.ts

@@ -0,0 +1,185 @@
+import type { BranchId, DatasetRid, FilePath, PageSize, PageToken } from "@osdk/internal.foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
+import type { File, ListFilesResponse, TransactionRid, TransactionType } from "../_components.js";
+/**
+ * Lists Files contained in a Dataset. By default files are listed on the latest view of the default
+ * branch - `master` for most enrollments.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most
+ * recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the
+ * branch if there are no snapshot transactions.
+ *
+ * To **list files on the resolved view of a transaction** specify the Transaction's resource identifier
+ * as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
+ *
+ * To **list files on the resolved view of a range of transactions** specify the the start transaction's resource
+ * identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This
+ * will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.
+ * Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when
+ * the start and end transactions do not belong to the same root-to-leaf path.
+ *
+ * To **list files on a specific transaction** specify the Transaction's resource identifier as both the
+ * `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that
+ * Transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/files
+ */
+export declare function listFiles($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+        pageSize?: PageSize | undefined;
+        pageToken?: PageToken | undefined;
+    }
+]): Promise<ListFilesResponse>;
+/**
+ * Uploads a File to an existing Dataset.
+ * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.
+ *
+ * By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.
+ * If the file already exists only the most recent version will be visible in the updated view.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will
+ * be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this
+ * default specify `transactionType` in addition to `branchId`.
+ * See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.
+ *
+ * To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as
+ * `transactionRid`. This is useful for uploading multiple files in a single transaction.
+ * See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/files:upload
+ */
+export declare function uploadFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $queryParams: {
+        filePath: FilePath;
+        branchId?: BranchId | undefined;
+        transactionType?: TransactionType | undefined;
+        transactionRid?: TransactionRid | undefined;
+    }
+]): Promise<File>;
+/**
+ * Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest
+ * view of the default branch - `master` for most enrollments.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will
+ * retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest
+ * ancestor transaction of the branch if there are no snapshot transactions.
+ *
+ * To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier
+ * as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
+ *
+ * To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
+ * This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the
+ * `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.
+ *
+ * To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the
+ * `startTransactionRid` and `endTransactionRid`.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
+ */
+export declare function getFileMetadata($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+    }
+]): Promise<File>;
+/**
+ * Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
+ * branch - `master` for most enrollments. The file will still be visible on historical views.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction
+ * will be created and committed on this branch.
+ *
+ * To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier
+ * as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a
+ * single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to
+ * open a transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
+ */
+export declare function deleteFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        transactionRid?: TransactionRid | undefined;
+    }
+]): Promise<void>;
+/**
+ * Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest
+ * view of the default branch - `master` for most enrollments.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will
+ * retrieve the content for the most recent version of the file since the latest snapshot transaction, or the
+ * earliest ancestor transaction of the branch if there are no snapshot transactions.
+ *
+ * To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier
+ * as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest
+ * snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.
+ *
+ * To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
+ * This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the
+ * `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior
+ * is undefined when the start and end transactions do not belong to the same root-to-leaf path.
+ *
+ * To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the
+ * `startTransactionRid` and `endTransactionRid`.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}/content
+ */
+export declare function getFileContent($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+    }
+]): Promise<unknown>;
+//# sourceMappingURL=File.d.ts.map

package/build/types/public/File.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../../src/public/File.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,EACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EACV,IAAI,EACJ,iBAAiB,EACjB,cAAc,EACd,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAiB3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IAEtB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,mBAAmB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QAC/C,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,iBAAiB,CAAC,CAE5B;AAcD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IAEtB,YAAY,EAAE;QACZ,QAAQ,EAAE,QAAQ,CAAC;QACnB,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;QAC9C,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC7C;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAElB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,mBAAmB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAaD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAElB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC7C;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAElB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,mBAAmB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,OAAO,CAAC,CAElB"}

package/build/types/public/Transaction.d.ts

@@ -0,0 +1,48 @@
+import type { BranchId, DatasetRid } from "@osdk/internal.foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
+import type { CreateTransactionRequest, Transaction, TransactionRid } from "../_components.js";
+/**
+ * Creates a Transaction on a Branch of a Dataset.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/transactions
+ */
+export declare function createTransaction($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $body: CreateTransactionRequest,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+    }
+]): Promise<Transaction>;
+/**
+ * Gets a Transaction of a Dataset.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/transactions/{transactionRid}
+ */
+export declare function getTransaction($ctx: $Client | $ClientContext, ...args: [datasetRid: DatasetRid, transactionRid: TransactionRid]): Promise<Transaction>;
+/**
+ * Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is
+ * updated to point to the Transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/transactions/{transactionRid}/commit
+ */
+export declare function commitTransaction($ctx: $Client | $ClientContext, ...args: [datasetRid: DatasetRid, transactionRid: TransactionRid]): Promise<Transaction>;
+/**
+ * Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is
+ * not updated.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/transactions/{transactionRid}/abort
+ */
+export declare function abortTransaction($ctx: $Client | $ClientContext, ...args: [datasetRid: DatasetRid, transactionRid: TransactionRid]): Promise<Transaction>;
+//# sourceMappingURL=Transaction.d.ts.map

package/build/types/public/Transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../../src/public/Transaction.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACX,cAAc,EACf,MAAM,mBAAmB,CAAC;AAY3B;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,KAAK,EAAE,wBAAwB;IAC/B,YAAY,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KAAE;CACnD,GACA,OAAO,CAAC,WAAW,CAAC,CAEtB;AASD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,GAChE,OAAO,CAAC,WAAW,CAAC,CAEtB;AASD;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,GAChE,OAAO,CAAC,WAAW,CAAC,CAEtB;AASD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,GAChE,OAAO,CAAC,WAAW,CAAC,CAEtB"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@osdk/internal.foundry.datasets",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./build/types/index.d.ts",
+      "browser": "./build/js/index.browser.mjs",
+      "import": "./build/js/index.mjs",
+      "require": "./build/js/index.cjs"
+    },
+    "./*": {
+      "types": "./build/types/public/*.d.ts",
+      "browser": "./build/js/public/*.browser.mjs",
+      "import": "./build/js/public/*.mjs",
+      "require": "./build/js/public/*.cjs"
+    }
+  },
+  "dependencies": {
+    "@osdk/internal.foundry.core": "0.0.0",
+    "@osdk/api": "^1.8.0"
+  },
+  "peerDependencies": {
+    "@osdk/shared.net": "^1.11.0",
+    "@osdk/client": "^0.19.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5",
+    "@osdk/shared.net": "^1.11.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build/types",
+    "build/js",
+    "CHANGELOG.md",
+    "package.json",
+    "templates",
+    "*.d.ts"
+  ],
+  "main": "./build/js/index.cjs",
+  "module": "./build/js/index.mjs",
+  "types": "./build/types/index.d.ts",
+  "sls": {
+    "dependencies": {
+      "com.palantir.foundry.api:api-gateway": {
+        "minVersion": "1.834.0",
+        "maxVersion": "1.x.x"
+      }
+    }
+  },
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
+    "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
+    "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
+    "transpile": "tsup",
+    "typecheck": "tsc-absolute"
+  }
+}