@nestbox-ai/doc-processing-api 0.0.1 → 1.0.62

package/.openapi-generator/FILES

@@ -0,0 +1,53 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+api.ts
+base.ts
+common.ts
+configuration.ts
+docs/ArtifactsApi.md
+docs/BatchQueryDto.md
+docs/CreateWebhookInputDto.md
+docs/DocumentCreateResponseDto.md
+docs/DocumentDto.md
+docs/DocumentSourcesResponseDto.md
+docs/DocumentsApi.md
+docs/ErrorDto.md
+docs/EvalCreateResponseDto.md
+docs/EvalDto.md
+docs/EvalsApi.md
+docs/GpuDeviceDto.md
+docs/GpuHealthCheckDto.md
+docs/HealthApi.md
+docs/HealthCheckItemDto.md
+docs/HealthChecksDto.md
+docs/HealthResponseDto.md
+docs/JobDto.md
+docs/JobLinksDto.md
+docs/JobStatusDto.md
+docs/JobsApi.md
+docs/PaginatedDocumentsDto.md
+docs/PaginatedEvalsDto.md
+docs/PaginatedJobsDto.md
+docs/PaginatedProfilesDto.md
+docs/PaginatedQueriesDto.md
+docs/PaginatedWebhooksDto.md
+docs/PaginationDto.md
+docs/ProfileDto.md
+docs/ProfilesApi.md
+docs/QueriesApi.md
+docs/QueryCreateResponseDto.md
+docs/SourceItemDto.md
+docs/SourcesApi.md
+docs/UpdateWebhookBodyInputDto.md
+docs/ValidationErrorDto.md
+docs/ValidationIssueDto.md
+docs/ValidationResultDto.md
+docs/WebhookDto.md
+docs/WebhooksApi.md
+git_push.sh
+index.ts
+package.json
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.19.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -1,45 +1,121 @@
-# @nestbox-ai/doc-processing-api
+## @nestbox-ai/doc-processing-api@1.0.62
+
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @nestbox-ai/doc-processing-api@1.0.62 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ArtifactsApi* | [**artifactsControllerDownloadDocumentArtifacts**](docs/ArtifactsApi.md#artifactscontrollerdownloaddocumentartifacts) | **GET** /documents/{documentId}/artifacts | Download document artifacts
+*DocumentsApi* | [**documentsControllerCreateDocument**](docs/DocumentsApi.md#documentscontrollercreatedocument) | **POST** /documents | Create document processing job
+*DocumentsApi* | [**documentsControllerGetDocument**](docs/DocumentsApi.md#documentscontrollergetdocument) | **GET** /documents/{documentId} | Read document
+*DocumentsApi* | [**documentsControllerListDocuments**](docs/DocumentsApi.md#documentscontrollerlistdocuments) | **GET** /documents | List documents
+*EvalsApi* | [**evalsControllerCreateEval**](docs/EvalsApi.md#evalscontrollercreateeval) | **POST** /documents/{documentId}/evals | Create an eval from YAML
+*EvalsApi* | [**evalsControllerGetEval**](docs/EvalsApi.md#evalscontrollergeteval) | **GET** /documents/{documentId}/evals/{evalId} | Read eval
+*EvalsApi* | [**evalsControllerListEvals**](docs/EvalsApi.md#evalscontrollerlistevals) | **GET** /documents/{documentId}/evals | List evals for a document
+*EvalsApi* | [**evalsControllerValidateEvalYaml**](docs/EvalsApi.md#evalscontrollervalidateevalyaml) | **POST** /documents/{documentId}/evals/validate | Validate eval YAML
+*HealthApi* | [**healthControllerGetHealth**](docs/HealthApi.md#healthcontrollergethealth) | **GET** /health | Get system health
+*JobsApi* | [**jobsControllerGetJob**](docs/JobsApi.md#jobscontrollergetjob) | **GET** /jobs/{jobId} | Read job
+*JobsApi* | [**jobsControllerGetJobStatus**](docs/JobsApi.md#jobscontrollergetjobstatus) | **GET** /jobs/{jobId}/status | Get job status
+*JobsApi* | [**jobsControllerListJobs**](docs/JobsApi.md#jobscontrollerlistjobs) | **GET** /jobs | List jobs
+*ProfilesApi* | [**profilesControllerCreateProfile**](docs/ProfilesApi.md#profilescontrollercreateprofile) | **POST** /profiles | Create profile from YAML
+*ProfilesApi* | [**profilesControllerGetProfile**](docs/ProfilesApi.md#profilescontrollergetprofile) | **GET** /profiles/{profileId} | Read profile
+*ProfilesApi* | [**profilesControllerGetProfileSchema**](docs/ProfilesApi.md#profilescontrollergetprofileschema) | **GET** /profiles/schema | Get profile schema
+*ProfilesApi* | [**profilesControllerListProfiles**](docs/ProfilesApi.md#profilescontrollerlistprofiles) | **GET** /profiles | List profiles
+*QueriesApi* | [**queriesControllerCreateQuery**](docs/QueriesApi.md#queriescontrollercreatequery) | **POST** /query | Create batch query from YAML
+*QueriesApi* | [**queriesControllerGetQuery**](docs/QueriesApi.md#queriescontrollergetquery) | **GET** /query/{queryId} | Read batch query
+*QueriesApi* | [**queriesControllerListQueries**](docs/QueriesApi.md#queriescontrollerlistqueries) | **GET** /query | List batch queries
+*QueriesApi* | [**queriesControllerValidateQueryYaml**](docs/QueriesApi.md#queriescontrollervalidatequeryyaml) | **POST** /query/validate | Validate batch query YAML
+*SourcesApi* | [**sourcesControllerGetDocumentSources**](docs/SourcesApi.md#sourcescontrollergetdocumentsources) | **GET** /documents/{documentId}/sources | Read document sources
+*WebhooksApi* | [**webhooksControllerCreateWebhook**](docs/WebhooksApi.md#webhookscontrollercreatewebhook) | **POST** /webhooks | Create webhook
+*WebhooksApi* | [**webhooksControllerDeleteWebhook**](docs/WebhooksApi.md#webhookscontrollerdeletewebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook
+*WebhooksApi* | [**webhooksControllerGetWebhook**](docs/WebhooksApi.md#webhookscontrollergetwebhook) | **GET** /webhooks/{webhookId} | Read webhook
+*WebhooksApi* | [**webhooksControllerListWebhooks**](docs/WebhooksApi.md#webhookscontrollerlistwebhooks) | **GET** /webhooks | List webhooks
+*WebhooksApi* | [**webhooksControllerUpdateWebhook**](docs/WebhooksApi.md#webhookscontrollerupdatewebhook) | **PATCH** /webhooks/{webhookId} | Update webhook
+
+
+### Documentation For Models
+
+ - [BatchQueryDto](docs/BatchQueryDto.md)
+ - [CreateWebhookInputDto](docs/CreateWebhookInputDto.md)
+ - [DocumentCreateResponseDto](docs/DocumentCreateResponseDto.md)
+ - [DocumentDto](docs/DocumentDto.md)
+ - [DocumentSourcesResponseDto](docs/DocumentSourcesResponseDto.md)
+ - [ErrorDto](docs/ErrorDto.md)
+ - [EvalCreateResponseDto](docs/EvalCreateResponseDto.md)
+ - [EvalDto](docs/EvalDto.md)
+ - [GpuDeviceDto](docs/GpuDeviceDto.md)
+ - [GpuHealthCheckDto](docs/GpuHealthCheckDto.md)
+ - [HealthCheckItemDto](docs/HealthCheckItemDto.md)
+ - [HealthChecksDto](docs/HealthChecksDto.md)
+ - [HealthResponseDto](docs/HealthResponseDto.md)
+ - [JobDto](docs/JobDto.md)
+ - [JobLinksDto](docs/JobLinksDto.md)
+ - [JobStatusDto](docs/JobStatusDto.md)
+ - [PaginatedDocumentsDto](docs/PaginatedDocumentsDto.md)
+ - [PaginatedEvalsDto](docs/PaginatedEvalsDto.md)
+ - [PaginatedJobsDto](docs/PaginatedJobsDto.md)
+ - [PaginatedProfilesDto](docs/PaginatedProfilesDto.md)
+ - [PaginatedQueriesDto](docs/PaginatedQueriesDto.md)
+ - [PaginatedWebhooksDto](docs/PaginatedWebhooksDto.md)
+ - [PaginationDto](docs/PaginationDto.md)
+ - [ProfileDto](docs/ProfileDto.md)
+ - [QueryCreateResponseDto](docs/QueryCreateResponseDto.md)
+ - [SourceItemDto](docs/SourceItemDto.md)
+ - [UpdateWebhookBodyInputDto](docs/UpdateWebhookBodyInputDto.md)
+ - [ValidationErrorDto](docs/ValidationErrorDto.md)
+ - [ValidationIssueDto](docs/ValidationIssueDto.md)
+ - [ValidationResultDto](docs/ValidationResultDto.md)
+ - [WebhookDto](docs/WebhookDto.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+Endpoints do not require authorization.
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@nestbox-ai/doc-processing-api`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**