Merge pull request #6 from zeroentropy-ai/release-please--branches--main--changes--next--components--zeroentropy

release: 0.1.0-alpha.2

Author: npip99

.github/workflows/publish-npm.yml

@@ -1,6 +1,6 @@
 # This workflow is triggered when a GitHub release is created.
 # It can also be run manually to re-publish to NPM in case it failed for some reason.
-# You can run this workflow by navigating to https://www.github.com/ZeroEntropy-AI/zeroentropy-node/actions/workflows/publish-npm.yml
+# You can run this workflow by navigating to https://www.github.com/zeroentropy-ai/zeroentropy-node/actions/workflows/publish-npm.yml
 name: Publish NPM
 on:
   workflow_dispatch:

.github/workflows/release-doctor.yml

@@ -9,7 +9,7 @@ jobs:
   release_doctor:
     name: release doctor
     runs-on: ubuntu-latest
-    if: github.repository == 'ZeroEntropy-AI/zeroentropy-node' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+    if: github.repository == 'zeroentropy-ai/zeroentropy-node' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
 
     steps:
       - uses: actions/checkout@v4

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.1"
+  ".": "0.1.0-alpha.2"
 }

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.1.0-alpha.2 (2025-01-18)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/zeroentropy-ai/zeroentropy-node/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** update via SDK Studio ([#10](https://github.com/zeroentropy-ai/zeroentropy-node/issues/10)) ([d599038](https://github.com/zeroentropy-ai/zeroentropy-node/commit/d599038d57c2ead625286aff71f945ddc1c3cfc0))
+* **api:** update via SDK Studio ([#11](https://github.com/zeroentropy-ai/zeroentropy-node/issues/11)) ([3eb5960](https://github.com/zeroentropy-ai/zeroentropy-node/commit/3eb59606d1c17fc5b8a0b461ffa95c4090f9498f))
+* **api:** update via SDK Studio ([#12](https://github.com/zeroentropy-ai/zeroentropy-node/issues/12)) ([eb87919](https://github.com/zeroentropy-ai/zeroentropy-node/commit/eb87919bd3f57a64ad0082be215c6a66438efbe9))
+* **api:** update via SDK Studio ([#13](https://github.com/zeroentropy-ai/zeroentropy-node/issues/13)) ([f104a26](https://github.com/zeroentropy-ai/zeroentropy-node/commit/f104a26939736b3ce81d90c09d204ba7b2309c43))
+* **api:** update via SDK Studio ([#14](https://github.com/zeroentropy-ai/zeroentropy-node/issues/14)) ([bb9467f](https://github.com/zeroentropy-ai/zeroentropy-node/commit/bb9467fa8e150520b8a5a41d6640e30accf6d292))
+* **api:** update via SDK Studio ([#5](https://github.com/zeroentropy-ai/zeroentropy-node/issues/5)) ([4cbe77d](https://github.com/zeroentropy-ai/zeroentropy-node/commit/4cbe77d77029907ed8e7cae27eaf02d85bad91a3))
+* **api:** update via SDK Studio ([#7](https://github.com/zeroentropy-ai/zeroentropy-node/issues/7)) ([8c2a250](https://github.com/zeroentropy-ai/zeroentropy-node/commit/8c2a250f8284daae8ec2b43b347f5b85d12c9507))
+* **api:** update via SDK Studio ([#8](https://github.com/zeroentropy-ai/zeroentropy-node/issues/8)) ([5b114e6](https://github.com/zeroentropy-ai/zeroentropy-node/commit/5b114e64b6a7e7367af7ff68e5a7326720933da1))
+* **api:** update via SDK Studio ([#9](https://github.com/zeroentropy-ai/zeroentropy-node/issues/9)) ([113b9a4](https://github.com/zeroentropy-ai/zeroentropy-node/commit/113b9a4778439d91c0031240d051ff18fc489a5a))
+
+
+### Documentation
+
+* remove stainless citation ([154c402](https://github.com/zeroentropy-ai/zeroentropy-node/commit/154c402c11bb09b38bb27ae3df9e5d0e78d06cd0))
+
 ## 0.1.0-alpha.1 (2025-01-18)
 
 Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/ZeroEntropy-AI/zeroentropy-node/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

CONTRIBUTING.md

@@ -42,14 +42,14 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```sh
-$ npm install git+ssh://[email protected]:ZeroEntropy-AI/zeroentropy-node.git
+$ npm install git+ssh://[email protected]:zeroentropy-ai/zeroentropy-node.git
 ```
 
 Alternatively, to link a local copy of the repo:
 
 ```sh
 # Clone
-$ git clone https://www.github.com/ZeroEntropy-AI/zeroentropy-node
+$ git clone https://www.github.com/zeroentropy-ai/zeroentropy-node
 $ cd zeroentropy-node
 
 # With yarn
@@ -99,7 +99,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/ZeroEntropy-AI/zeroentropy-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/zeroentropy-ai/zeroentropy-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Zeroentropy
+   Copyright 2025 ZeroEntropy
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,10 +1,10 @@
-# Zeroentropy Node API Library
+# ZeroEntropy Node API Library
 
 [![NPM version](https://img.shields.io/npm/v/zeroentropy.svg)](https://npmjs.org/package/zeroentropy) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/zeroentropy)
 
-This library provides convenient access to the Zeroentropy REST API from server-side TypeScript or JavaScript.
+This library provides convenient access to the ZeroEntropy REST API from server-side TypeScript or JavaScript.
 
-The REST API documentation can be found on [docs.zeroentropy.com](https://docs.zeroentropy.com). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [docs.zeroentropy.dev](https://docs.zeroentropy.dev/api-reference). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -18,16 +18,20 @@ The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import Zeroentropy from 'zeroentropy';
+import ZeroEntropy from 'zeroentropy';
 
-const client = new Zeroentropy({
+const client = new ZeroEntropy({
   apiKey: process.env['ZEROENTROPY_API_KEY'], // This is the default and can be omitted
 });
 
 async function main() {
-  const response = await client.documents.getInfo({ collection_name: 'collection_name', path: 'path' });
+  const response = await client.documents.add({
+    collection_name: 'example_collection',
+    content: { type: 'text', text: 'Example Content' },
+    path: 'my_document.txt',
+  });
 
-  console.log(response.document);
+  console.log(response.message);
 }
 
 main();
@@ -39,15 +43,14 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import Zeroentropy from 'zeroentropy';
+import ZeroEntropy from 'zeroentropy';
 
-const client = new Zeroentropy({
+const client = new ZeroEntropy({
   apiKey: process.env['ZEROENTROPY_API_KEY'], // This is the default and can be omitted
 });
 
 async function main() {
-  const params: Zeroentropy.DocumentGetInfoParams = { collection_name: 'collection_name', path: 'path' };
-  const response: Zeroentropy.DocumentGetInfoResponse = await client.documents.getInfo(params);
+  const response: ZeroEntropy.StatusGetStatusResponse = await client.status.getStatus();
 }
 
 main();
@@ -64,17 +67,15 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 async function main() {
-  const response = await client.documents
-    .getInfo({ collection_name: 'collection_name', path: 'path' })
-    .catch(async (err) => {
-      if (err instanceof Zeroentropy.APIError) {
-        console.log(err.status); // 400
-        console.log(err.name); // BadRequestError
-        console.log(err.headers); // {server: 'nginx', ...}
-      } else {
-        throw err;
-      }
-    });
+  const response = await client.status.getStatus().catch(async (err) => {
+    if (err instanceof ZeroEntropy.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
 }
 
 main();
@@ -104,12 +105,12 @@ You can use the `maxRetries` option to configure or disable this:
 <!-- prettier-ignore -->
 ```js
 // Configure the default for all requests:
-const client = new Zeroentropy({
+const client = new ZeroEntropy({
   maxRetries: 0, // default is 2
 });
 
 // Or, configure per-request:
-await client.documents.getInfo({ collection_name: 'collection_name', path: 'path' }, {
+await client.status.getStatus({
   maxRetries: 5,
 });
 ```
@@ -121,12 +122,12 @@ Requests time out after 1 minute by default. You can configure this with a `time
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
-const client = new Zeroentropy({
+const client = new ZeroEntropy({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
 // Override per-request:
-await client.documents.getInfo({ collection_name: 'collection_name', path: 'path' }, {
+await client.status.getStatus({
   timeout: 5 * 1000,
 });
 ```
@@ -135,6 +136,39 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
 
 Note that requests which time out will be [retried twice by default](#retries).
 
+## Auto-pagination
+
+List methods in the ZeroEntropy API are paginated.
+You can use the `for await … of` syntax to iterate through items across all pages:
+
+```ts
+async function fetchAllDocuments(params) {
+  const allDocuments = [];
+  // Automatically fetches more pages as needed.
+  for await (const documentGetInfoListResponse of client.documents.getInfoList({
+    collection_name: 'example_collection',
+  })) {
+    allDocuments.push(documentGetInfoListResponse);
+  }
+  return allDocuments;
+}
+```
+
+Alternatively, you can request a single page at a time:
+
+```ts
+let page = await client.documents.getInfoList({ collection_name: 'example_collection' });
+for (const documentGetInfoListResponse of page.documents) {
+  console.log(documentGetInfoListResponse);
+}
+
+// Convenience methods are provided for manually paginating:
+while (page.hasNextPage()) {
+  page = await page.getNextPage();
+  // ...
+}
+```
+
 ## Advanced Usage
 
 ### Accessing raw Response data (e.g., headers)
@@ -145,19 +179,15 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 
 <!-- prettier-ignore -->
 ```ts
-const client = new Zeroentropy();
+const client = new ZeroEntropy();
 
-const response = await client.documents
-  .getInfo({ collection_name: 'collection_name', path: 'path' })
-  .asResponse();
+const response = await client.status.getStatus().asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: response, response: raw } = await client.documents
-  .getInfo({ collection_name: 'collection_name', path: 'path' })
-  .withResponse();
+const { data: response, response: raw } = await client.status.getStatus().withResponse();
 console.log(raw.headers.get('X-My-Header'));
-console.log(response.document);
+console.log(response.num_documents);
 ```
 
 ### Making custom/undocumented requests
@@ -210,17 +240,17 @@ By default, this library uses `node-fetch` in Node, and expects a global `fetch`
 
 If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
 (for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
-add the following import before your first import `from "Zeroentropy"`:
+add the following import before your first import `from "ZeroEntropy"`:
 
 ```ts
 // Tell TypeScript and the package to use the global web fetch instead of node-fetch.
 // Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
 import 'zeroentropy/shims/web';
-import Zeroentropy from 'zeroentropy';
+import ZeroEntropy from 'zeroentropy';
 ```
 
 To do the inverse, add `import "zeroentropy/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/ZeroEntropy-AI/zeroentropy-node/tree/main/src/_shims#readme)).
+This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/zeroentropy-ai/zeroentropy-node/tree/main/src/_shims#readme)).
 
 ### Logging and middleware
 
@@ -229,9 +259,9 @@ which can be used to inspect or alter the `Request` or `Response` before/after e
 
 ```ts
 import { fetch } from 'undici'; // as one example
-import Zeroentropy from 'zeroentropy';
+import ZeroEntropy from 'zeroentropy';
 
-const client = new Zeroentropy({
+const client = new ZeroEntropy({
   fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     console.log('About to make a request', url, init);
     const response = await fetch(url, init);
@@ -256,17 +286,14 @@ import http from 'http';
 import { HttpsProxyAgent } from 'https-proxy-agent';
 
 // Configure the default for all requests:
-const client = new Zeroentropy({
+const client = new ZeroEntropy({
   httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
 });
 
 // Override per-request:
-await client.documents.getInfo(
-  { collection_name: 'collection_name', path: 'path' },
-  {
-    httpAgent: new http.Agent({ keepAlive: false }),
-  },
-);
+await client.status.getStatus({
+  httpAgent: new http.Agent({ keepAlive: false }),
+});
 ```
 
 ## Semantic versioning
@@ -279,7 +306,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-We are keen for your feedback; please open an [issue](https://www.github.com/ZeroEntropy-AI/zeroentropy-node/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/zeroentropy-ai/zeroentropy-node/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Zeroentropy please follow the respective company's security reporting guidelines.
+or products provided by ZeroEntropy please follow the respective company's security reporting guidelines.
 
-### Zeroentropy Terms and Policies
+### ZeroEntropy Terms and Policies
 
-Please contact founders@zeroentropy.com for any questions or concerns regarding security of our services.
+Please contact founders@zeroentropy.dev for any questions or concerns regarding security of our services.
 
 ---
 

api.md

@@ -63,9 +63,3 @@ Types:
 Methods:
 
 - <code title="post /parsers/parse-document">client.parsers.<a href="./src/resources/parsers.ts">parseDocument</a>({ ...params }) -> ParserParseDocumentResponse</code>
-
-# Models
-
-Types:
-
-- <code><a href="./src/resources/models.ts">StrJson</a></code>

package.json

@@ -1,12 +1,12 @@
 {
   "name": "zeroentropy",
-  "version": "0.1.0-alpha.1",
-  "description": "The official TypeScript library for the Zeroentropy API",
-  "author": "Zeroentropy <founders@zeroentropy.com>",
+  "version": "0.1.0-alpha.2",
+  "description": "The official TypeScript library for the ZeroEntropy API",
+  "author": "ZeroEntropy <founders@zeroentropy.dev>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",
-  "repository": "github:ZeroEntropy-AI/zeroentropy-node",
+  "repository": "github:zeroentropy-ai/zeroentropy-node",
   "license": "Apache-2.0",
   "packageManager": "[email protected]",
   "files": [