@arina_ai_test/arina-grid-di 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Arina
+
+   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.

package/README.md

@@ -1,3 +1,220 @@
-# Temporary Holding Version
+# Arina Document Intelligence API
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This library provides convenient access to the Arina Document Intelligence API from TypeScript or JavaScript.
+
+The full API of this library can be found in [api.md](./api.md).
+
+<br />
+
+## Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Waiting for a run](#waiting-for-a-run)
+- [API Reference](./api.md)
+- [Authentication](#authentication)
+- [Errors](#errors)
+- [Client Options](#client-options)
+- [Request Options](#request-options)
+- [Retries and Timeouts](#retries-and-timeouts)
+- [Helpers](#helpers)
+- [Logging](#logging)
+- [Requirements](#requirements)
+
+<br />
+
+## Installation
+
+```sh
+npm install @arina_ai_test/arina-grid-di
+```
+
+<br />
+
+## Usage
+
+You need the base URL of the service you are using (Arina-hosted, or your organisation's own
+deployment) and the API key that goes with it. Both are required: the client has no default host.
+
+```ts
+import { readFile, writeFile } from 'node:fs/promises';
+import ArinaDocumentIntelligenceAPI from '@arina_ai_test/arina-grid-di';
+
+const client = new ArinaDocumentIntelligenceAPI({
+  apiKeyAuth: '<your key>',
+  baseURL: 'https://<your base url>',
+});
+
+// Runs are asynchronous: POST returns 202 with a run id, then you poll.
+// `config` is the ExtractRunRequest object as a JSON string (one multipart form field).
+const run = await client.extraction.createExtractRun({
+  file: new File([await readFile('invoice.pdf')], 'invoice.pdf', { type: 'application/pdf' }),
+  config: JSON.stringify({
+    organizationId: 'org_123',
+    config: {
+      jsonSchema: {
+        type: 'object',
+        properties: {
+          invoiceNumber: { type: ['string', 'null'] },
+          invoiceTotal: { type: ['number', 'null'], description: 'Total amount due' },
+        },
+      },
+      citationsEnabled: true,
+    },
+  }),
+});
+console.log(run.id, run.status); // exr_..., PROCESSING
+```
+
+The examples in the following sections assume a `client` configured as shown above.
+
+See the [API reference](./api.md) for every available operation.
+
+<br />
+
+## Waiting for a run
+
+`@arina_ai_test/arina-grid-di/lib` adds helpers that poll a run until it reaches a terminal status
+(`PROCESSED`, `FAILED`, `CANCELLED`), with backoff, a timeout and an optional `AbortSignal`:
+
+```ts
+import { waitForExtractRun } from '@arina_ai_test/arina-grid-di/lib';
+
+const done = await waitForExtractRun(client, run.id, { timeoutMs: 120_000 });
+
+const total = done.output?.value?.['invoiceTotal'];
+// `citations` is an array when the value was located, [] when found but not located,
+// and undefined/null when citations were disabled — so guard before iterating.
+for (const citation of done.output?.metadata?.['invoiceTotal']?.citations ?? []) {
+  console.log(citation.page?.number, citation.polygon, citation.referenceText);
+}
+
+// The page image the polygons were measured against:
+const page = await client.extraction.listExtractRunPage(done.id);
+await writeFile('page.jpg', Buffer.from(await page.arrayBuffer()));
+```
+
+`waitForParseRun` does the same for parse runs. A `FAILED` or `CANCELLED` run throws
+`RunFailedError` (the run is on `.run`); pass `raiseOnFailure: false` to get it back instead.
+Exceeding `timeoutMs` throws `RunTimeoutError`. Unknown statuses are treated as still running,
+because status is an open string.
+
+<br />
+
+## Authentication
+
+Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `apiKeyAuth` | `string \| provider` | - | Credential for the ApiKeyAuth scheme. Defaults to API_KEY_AUTH. |
+
+Declared schemes:
+
+- `ApiKeyAuth` API key in header `X-API-Key`
+
+<br />
+
+## Errors
+
+Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.
+
+```ts
+import { APIError } from '@arina_ai_test/arina-grid-di';
+
+try {
+  const extractRun = await client.extraction.createExtractRun({
+    file: new File(['file'], 'file'),
+    config:
+      '{"organizationId": "org_123", "config": {"jsonSchema": {"type": "object", "properties": {"invoiceNumber": {"type": ["string", "null"]}, "invoiceTotal": {"type": ["number", "null"], "description": "Total amount due"}}}, "citationsEnabled": true}}',
+  });
+} catch (err) {
+  if (err instanceof APIError) {
+    console.log(err.status, err.name, err.headers);
+  }
+  throw err;
+}
+```
+
+Documented error statuses: `400`, `404`, `409`, `422`, `503`.
+
+<br />
+
+## Client Options
+
+Configure the generated client by setting any of these options when you create it.
+
+```ts
+import ArinaDocumentIntelligenceAPI from '@arina_ai_test/arina-grid-di';
+
+const client = new ArinaDocumentIntelligenceAPI({
+  timeout: 60000,
+  maxRetries: 2,
+  logLevel: 'debug',
+});
+```
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `apiKeyAuth` | `string \| AuthTokenProvider` | `process.env["API_KEY_AUTH"]` | Credential for the ApiKeyAuth scheme. |
+| `baseURL` | `string \| null` | `process.env["ARINA_BASE_URL"]` | Override the default API base URL. Pass `null` when selecting a configured environment. |
+| `timeout` | `number` | `60000` | Maximum time in milliseconds to wait for a response before aborting a request. |
+| `maxRetries` | `number` | `2` | Number of retries for temporary failures. |
+| `defaultHeaders` | `HeadersInit` | - | Headers sent with every request. |
+| `defaultQuery` | `Record<string, string \| undefined>` | - | Query parameters sent with every request. |
+| `fetchOptions` | `RequestInit` | - | Additional fetch options sent with every request. |
+| `fetch` | `Fetch` | - | Custom fetch implementation. |
+| `logLevel` | `"off" \| "error" \| "warn" \| "info" \| "debug" \| null` | `process.env["ARINA_LOG"]` | Controls request and retry debug logging. |
+| `logger` | `Logger \| null` | `console` | Custom logger implementation. |
+
+<br />
+
+## Request Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `headers` | `HeadersInit` | - | Per-request headers. |
+| `query` | `Record<string, unknown>` | - | Per-request query parameters. |
+| `body` | `unknown` | - | Override the generated request body. |
+| `timeout` | `number` | - | Per-request timeout in milliseconds. |
+| `maxRetries` | `number` | - | Per-request retry count. |
+| `signal` | `AbortSignal` | - | Abort an in-flight request. |
+| `fetchOptions` | `RequestInit` | - | Per-request fetch options. |
+| `idempotencyKey` | `string` | - | Idempotency key for retry-safe operations. Applies to this request and its retries. |
+
+<br />
+
+## Retries and Timeouts
+
+Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor `Retry-After` headers when present. Tune the retry and timeout client options shown above, or override them per request.
+
+<br />
+
+## Helpers
+
+- Use `.withResponse()` on any request to inspect both parsed data and the raw `Response` object.
+- Every operation returns an `APIPromise`, so you can `await` it directly or chain `.withResponse()`.
+
+<br />
+
+## Logging
+
+- Set `logLevel: "debug"` to log request URLs, options, response status, response headers, and retry attempts.
+- Pass a custom `logger` to route logs into your own observability pipeline.
+- Set `logLevel: null` to disable environment-driven logging.
+
+<br />
+
+## Requirements
+
+- Node.js 20+, a modern browser, or any runtime with `fetch` support
+
+<br />
+
+## Contributing
+
+Client code under `src/` (except `src/lib/`) is generated from the API's OpenAPI document; helpers,
+tests and release automation are maintained here. See [CONTRIBUTING.md](./CONTRIBUTING.md).
+Security reports: [SECURITY.md](./SECURITY.md).
+
+Client generated with Scalar.

package/SKILL.md

@@ -0,0 +1,78 @@
+---
+name: arina-document-intelligence-api-typescript-sdk
+description: "TypeScript SDK for Arina Document Intelligence API. Use when writing TypeScript code that calls Arina Document Intelligence API with the @arina-ai/arina-grid-di package: installing it, constructing and authenticating the client, and calling API operations."
+---
+
+# Arina Document Intelligence API TypeScript SDK
+
+Generated TypeScript client for Arina Document Intelligence API, published as `@arina-ai/arina-grid-di`. Use the generated client instead of hand-writing HTTP requests.
+
+## Install
+
+```sh
+npm install @arina-ai/arina-grid-di
+```
+
+## Client setup and authentication
+
+```ts
+import ArinaDocumentIntelligenceAPI from '@arina-ai/arina-grid-di';
+
+const client = new ArinaDocumentIntelligenceAPI({
+  apiKeyAuth: process.env['API_KEY_AUTH'], // defaults to the API_KEY_AUTH env var
+});
+```
+
+Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them:
+
+- `apiKeyAuth` (env: `API_KEY_AUTH`) — Credential for the ApiKeyAuth scheme.
+
+## Calling operations
+
+```ts
+import ArinaDocumentIntelligenceAPI from '@arina-ai/arina-grid-di';
+
+const client = new ArinaDocumentIntelligenceAPI({
+  apiKeyAuth: process.env['API_KEY_AUTH'], // defaults to the API_KEY_AUTH env var
+});
+
+const extractRun = await client.extraction.createExtractRun({
+  file: new File(['file'], 'file'),
+  config:
+    '{"organizationId": "org_123", "config": {"jsonSchema": {"type": "object", "properties": {"invoiceNumber": {"type": ["string", "null"]}, "invoiceTotal": {"type": ["number", "null"], "description": "Total amount due"}}}, "citationsEnabled": true}}',
+});
+
+console.log(extractRun);
+```
+
+Method names, parameter shapes, and response types are generated from the API description — do not guess them. Look up the exact call signature in [api.md](./api.md) before writing a call.
+
+## Error handling
+
+Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.
+
+```ts
+import { APIError } from '@arina-ai/arina-grid-di';
+
+try {
+  const extractRun = await client.extraction.createExtractRun({
+    file: new File(['file'], 'file'),
+    config:
+      '{"organizationId": "org_123", "config": {"jsonSchema": {"type": "object", "properties": {"invoiceNumber": {"type": ["string", "null"]}, "invoiceTotal": {"type": ["number", "null"], "description": "Total amount due"}}}, "citationsEnabled": true}}',
+  });
+} catch (err) {
+  if (err instanceof APIError) {
+    console.log(err.status, err.name, err.headers);
+  }
+  throw err;
+}
+```
+
+## Requirements
+
+- Node.js 20+, a modern browser, or any runtime with `fetch` support
+
+## Reference files
+
+- [README.md](./README.md) — full feature tour: client options, request options, retries and timeouts, logging.
+- [api.md](./api.md) — complete catalogue of every operation with request and response types.