@aerostack/sdk-web 0.8.8 → 0.8.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aerostack/sdk-web",
-  "version": "0.8.8",
+  "version": "0.8.9",
   "author": "Aerostack",
   "type": "module",
   "tshy": {
@@ -61,5 +61,12 @@
   },
   "main": "./dist/commonjs/index.js",
   "types": "./dist/commonjs/index.d.ts",
-  "module": "./dist/esm/index.js"
+  "module": "./dist/esm/index.js",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/FUNCTIONS.md

@@ -1,95 +0,0 @@
-# Standalone Functions
-
-> [!NOTE]
-> This section is useful if you are using a bundler and targetting browsers and
-> runtimes where the size of an application affects performance and load times. 
-
-Every method in this SDK is also available as a standalone function. This
-alternative API is suitable when targetting the browser or serverless runtimes
-and using a bundler to build your application since all unused functionality
-will be tree-shaken away. This includes code for unused methods, Zod schemas,
-encoding helpers and response handlers. The result is dramatically smaller
-impact on the application's final bundle size which grows very slowly as you use
-more and more functionality from this SDK.
-
-Calling methods through the main SDK class remains a valid and generally more
-more ergonomic option. Standalone functions represent an optimisation for a
-specific category of applications.
-
-## Example
-
-```typescript
-import { SDKCore } from "@aerostack/sdk-web/core.js";
-import { databaseDbQuery } from "@aerostack/sdk-web/funcs/databaseDbQuery.js";
-
-// Use `SDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const sdk = new SDKCore({
-  apiKeyAuth: "<YOUR_API_KEY_HERE>",
-});
-
-async function run() {
-  const res = await databaseDbQuery(sdk, {
-    xSDKVersion: "0.1.0",
-    requestBody: {
-      sql: "SELECT * FROM users WHERE active = ?",
-      params: [
-        true,
-      ],
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("databaseDbQuery failed:", res.error);
-  }
-}
-
-run();
-```
-
-## Result types
-
-Standalone functions differ from SDK methods in that they return a
-`Result<Value, Error>` type to capture _known errors_ and document them using
-the type system. By avoiding throwing errors, application code maintains clear
-control flow and error-handling become part of the regular flow of application
-code.
-
-> We use the term "known errors" because standalone functions, and JavaScript
-> code in general, can still throw unexpected errors such as `TypeError`s,
-> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
-> something this SDK addresses in the future. Nevertheless, there is still a lot
-> of benefit from capturing most errors and turning them into values.
-
-The second reason for this style of programming is because these functions will
-typically be used in front-end applications where exception throwing is
-sometimes discouraged or considered unidiomatic. React and similar ecosystems
-and libraries tend to promote this style of programming so that components
-render useful content under all states (loading, success, error and so on).
-
-The general pattern when calling standalone functions looks like this:
-
-```typescript
-import { Core } from "<sdk-package-name>";
-import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
-
-const client = new Core();
-
-async function run() {
-  const result = await fetchSomething(client, { id: "123" });
-  if (!result.ok) {
-    // You can throw the error or handle it. It's your choice now.
-    throw result.error;
-  }
-
-  console.log(result.value);
-}
-
-run();
-```
-
-Notably, `result.error` above will have an explicit type compared to a try-catch
-variation where the error in the catch block can only be of type `unknown` (or
-`any` depending on your TypeScript settings).

package/RUNTIMES.md

@@ -1,48 +0,0 @@
-# Supported JavaScript runtimes
-
-This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
-
-- [Web Fetch API][web-fetch]
-- [Web Streams API][web-streams] and in particular `ReadableStream`
-- [Async iterables][async-iter] using `Symbol.asyncIterator`
-
-[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
-[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
-[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
-
-Runtime environments that are explicitly supported are:
-
-- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
-- Node.js active and maintenance LTS releases
-  - Currently, this is v18 and v20
-- Bun v1 and above
-- Deno v1.39
-  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
-
-[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
-
-## Recommended TypeScript compiler options
-
-The following `tsconfig.json` options are recommended for projects using this
-SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of],
-[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
-so on):
-
-[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
-[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
-[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
-[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
-
-```jsonc
-{
-  "compilerOptions": {
-    "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"]
-  }
-}
-```
-
-While `target` can be set to older ECMAScript versions, it may result in extra,
-unnecessary compatibility code being generated if you are not targeting old
-runtimes.

package/examples/aiAIChat.example.ts

@@ -1,31 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import dotenv from "dotenv";
-dotenv.config();
-/**
- * Example usage of the @aerostack/sdk-web SDK
- *
- * To run this example from the examples directory:
- * npm run build && npx tsx aiAIChat.example.ts
- */
-
-import { SDK } from "@aerostack/sdk-web";
-
-const sdk = new SDK({
-  apiKeyAuth: "<YOUR_API_KEY_HERE>",
-});
-
-async function main() {
-  const result = await sdk.ai.aiChat({
-    messages: [
-      {},
-    ],
-    model: "@cf/meta/llama-3-8b-instruct",
-  });
-
-  console.log(result);
-}
-
-main().catch(console.error);

package/examples/databaseDbQuery.example.ts

@@ -1,34 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import dotenv from "dotenv";
-dotenv.config();
-/**
- * Example usage of the @aerostack/sdk-web SDK
- *
- * To run this example from the examples directory:
- * npm run build && npx tsx databaseDbQuery.example.ts
- */
-
-import { SDK } from "@aerostack/sdk-web";
-
-const sdk = new SDK({
-  apiKeyAuth: "<YOUR_API_KEY_HERE>",
-});
-
-async function main() {
-  const result = await sdk.database.dbQuery({
-    xSDKVersion: "0.1.0",
-    requestBody: {
-      sql: "SELECT * FROM users WHERE active = ?",
-      params: [
-        true,
-      ],
-    },
-  });
-
-  console.log(result);
-}
-
-main().catch(console.error);

package/examples/e2e/__tests__/e2e.test.ts

@@ -1,69 +0,0 @@
-/**
- * Web SDK E2E Tests
- *
- * Verifies SDK initialization and client-safe surface.
- */
-import { describe, it, expect } from 'vitest';
-import { SDK, Aerostack, createClient, RealtimeClient } from '@aerostack/sdk-web';
-
-describe('Web SDK E2E', () => {
-  describe('SDK initialization', () => {
-    it('should create SDK instance with default options', () => {
-      const sdk = new SDK();
-      expect(sdk).toBeDefined();
-      expect(sdk.auth).toBeDefined();
-      expect(sdk.ai).toBeDefined();
-      expect(sdk.storage).toBeDefined();
-      expect(sdk.database).toBeDefined();
-      expect(sdk.realtime).toBeDefined();
-    });
-
-    it('should create SDK with api key', () => {
-      const sdk = new SDK({
-        apiKey: 'ac_public_test_key',
-        serverUrl: 'https://custom.api.com/v1',
-      });
-      expect(sdk).toBeDefined();
-    });
-
-    it('should not expose server-side APIs', () => {
-      const sdk = new SDK() as any;
-      expect(sdk.queue).toBeUndefined();
-      expect(sdk.services).toBeUndefined();
-      expect(sdk.gateway).toBeUndefined();
-      expect(sdk.cache).toBeUndefined();
-    });
-
-    it('should export Aerostack as deprecated alias', () => {
-      expect(Aerostack).toBe(SDK);
-    });
-
-    it('should export createClient factory', () => {
-      const sdk = createClient({ apiKey: 'key' });
-      expect(sdk).toBeInstanceOf(SDK);
-    });
-  });
-
-  describe('setApiKey', () => {
-    it('should update API key', () => {
-      const sdk = new SDK({ apiKey: 'old-key' });
-      sdk.setApiKey('new-key');
-      expect(sdk.auth).toBeDefined();
-    });
-  });
-
-  describe('RealtimeClient export', () => {
-    it('should export RealtimeClient', () => {
-      expect(RealtimeClient).toBeDefined();
-      expect(typeof RealtimeClient).toBe('function');
-    });
-
-    it('should create realtime client', () => {
-      const client = new RealtimeClient({
-        baseUrl: 'https://api.test.com/v1',
-        projectId: 'proj-1',
-      });
-      expect(client.status).toBe('idle');
-    });
-  });
-});

package/examples/e2e/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "@aerostack/web-e2e",
-  "version": "1.0.0",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "test": "vitest run"
-  },
-  "dependencies": {
-    "@aerostack/sdk-web": "file:../../"
-  },
-  "devDependencies": {
-    "vitest": "^1.0.0"
-  }
-}

package/examples/e2e/vitest.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-  },
-});

package/examples/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "@aerostack/sdk-web-examples",
-  "version": "1.0.0",
-  "private": true,
-  "scripts": {
-    "build:parent": "cd .. && npm i && npm run build && cd -",
-    "build:examples": "npm i",
-    "build": "npm run build:parent && npm run build:examples"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "dotenv": "^16.4.5",
-    "tsx": "^4.19.2"
-  },
-  "dependencies": {
-    "@aerostack/sdk-web": "file:.."
-  }
-}

package/jsr.json

@@ -1,27 +0,0 @@
-
-
-{
-  "name": "@aerostack/sdk-web",
-  "version": "0.3.3",
-  "exports": {
-    ".": "./src/index.ts",    
-    "./sdk/models/errors": "./src/sdk/models/errors/index.ts",    
-    "./sdk/models/shared": "./src/sdk/models/shared/index.ts",    
-    "./sdk/models/operations": "./src/sdk/models/operations/index.ts",
-    "./lib/config": "./src/lib/config.ts",
-    "./lib/http": "./src/lib/http.ts",
-    "./lib/retries": "./src/lib/retries.ts",
-    "./lib/sdks": "./src/lib/sdks.ts",
-    "./types": "./src/sdk/types/index.ts"
-  },
-  "publish": {
-    "include": [
-      "LICENSE",
-      "README.md",
-      "RUNTIMES.md",
-      "USAGE.md",
-      "jsr.json",
-      "src/**/*.ts"
-    ]
-  }
-}