@kestra-io/kestra-sdk 2.0.0-dev.4bc905a7.0b725cca → 2.0.0-dev.4bc905a7.6706a2d2

package/README.md

@@ -0,0 +1,147 @@
+# JavaScript SDK
+
+## Steps to generate the SDK
+
+1. Update the `kestra-ee.yml` if necessary with latest openspec api changes.
+2. Generate the SDK using the script `generate-sdks.sh` that uses the openapi-generator-cli docker image.
+
+## Installation
+
+```bash
+npm install @kestra-io/kestra-sdk
+```
+
+## Usage
+
+The SDK is organized into domain-specific modules (e.g. `flows`, `executions`, `apps`, `plugins`). Import only the modules you need to keep your bundle lean and benefit from tree-shaking.
+
+### Configure the client
+
+Import and configure the shared HTTP client once, at the entry point of your application:
+
+```ts
+import { client } from "@kestra-io/kestra-sdk/client";
+
+client.setConfig({
+    baseURL: "https://<your-kestra-host>",
+    auth: () => "<username>:<password>",
+});
+```
+
+For token-based authentication, pass the token directly:
+
+```ts
+client.setConfig({
+    baseURL: "https://<your-kestra-host>",
+    auth: () => "<your-api-token>",
+});
+```
+
+### Import domain modules
+
+Each domain is a separate entry point. Import them with a namespace alias to keep call sites readable:
+
+```ts
+import * as FlowsAPI      from "@kestra-io/kestra-sdk/flows";
+import * as ExecutionsAPI from "@kestra-io/kestra-sdk/executions";
+import * as AppsAPI       from "@kestra-io/kestra-sdk/apps";
+import * as PluginsAPI    from "@kestra-io/kestra-sdk/plugins";
+```
+
+Other available domains:
+
+```ts
+import * as AiAPI                   from "@kestra-io/kestra-sdk/ai";
+import * as AssetsAPI               from "@kestra-io/kestra-sdk/assets";
+import * as AuditLogsAPI            from "@kestra-io/kestra-sdk/audit-logs";
+import * as AuthsAPI                from "@kestra-io/kestra-sdk/auths";
+import * as BannersAPI              from "@kestra-io/kestra-sdk/banners";
+import * as BindingsAPI             from "@kestra-io/kestra-sdk/bindings";
+import * as BlueprintTagsAPI        from "@kestra-io/kestra-sdk/blueprint-tags";
+import * as BlueprintsAPI           from "@kestra-io/kestra-sdk/blueprints";
+import * as ClusterAPI              from "@kestra-io/kestra-sdk/cluster";
+import * as DashboardsAPI           from "@kestra-io/kestra-sdk/dashboards";
+import * as FilesAPI                from "@kestra-io/kestra-sdk/files";
+import * as GroupsAPI               from "@kestra-io/kestra-sdk/groups";
+import * as InvitationsAPI          from "@kestra-io/kestra-sdk/invitations";
+import * as KillSwitchesAPI         from "@kestra-io/kestra-sdk/kill-switches";
+import * as KvAPI                   from "@kestra-io/kestra-sdk/kv";
+import * as LoginAPI                from "@kestra-io/kestra-sdk/login";
+import * as LogsAPI                 from "@kestra-io/kestra-sdk/logs";
+import * as MetricsAPI              from "@kestra-io/kestra-sdk/metrics";
+import * as MiscAPI                 from "@kestra-io/kestra-sdk/misc";
+import * as NamespacesAPI           from "@kestra-io/kestra-sdk/namespaces";
+import * as OutputsAPI              from "@kestra-io/kestra-sdk/outputs";
+import * as RolesAPI                from "@kestra-io/kestra-sdk/roles";
+import * as ScimConfigurationAPI    from "@kestra-io/kestra-sdk/scim-configuration";
+import * as ScimGroupsAPI           from "@kestra-io/kestra-sdk/scim-groups";
+import * as ScimUsersAPI            from "@kestra-io/kestra-sdk/scim-users";
+import * as SecretsAPI              from "@kestra-io/kestra-sdk/secrets";
+import * as SecurityIntegrationsAPI from "@kestra-io/kestra-sdk/security-integrations";
+import * as ServiceAccountAPI       from "@kestra-io/kestra-sdk/service-account";
+import * as ServicesAPI             from "@kestra-io/kestra-sdk/services";
+import * as SharedAPI               from "@kestra-io/kestra-sdk/shared";
+import * as TenantAccessAPI         from "@kestra-io/kestra-sdk/tenant-access";
+import * as TenantsAPI              from "@kestra-io/kestra-sdk/tenants";
+import * as TestSuitesAPI           from "@kestra-io/kestra-sdk/test-suites";
+import * as TriggersAPI             from "@kestra-io/kestra-sdk/triggers";
+import * as UsersAPI                from "@kestra-io/kestra-sdk/users";
+import * as WorkerAuthAPI           from "@kestra-io/kestra-sdk/worker-auth";
+import * as WorkerGroupsAPI         from "@kestra-io/kestra-sdk/worker-groups";
+```
+
+### Example: search and create a flow
+
+```ts
+import { client } from "@kestra-io/kestra-sdk/client";
+import * as FlowsAPI from "@kestra-io/kestra-sdk/flows";
+
+client.setConfig({
+    baseURL: "https://<your-kestra-host>",
+    auth: () => "root@root.com:Root!1234",
+});
+
+const tenantId = "main";
+
+// Search flows
+const searchRes = await FlowsAPI.searchFlows({
+    page: 1,
+    size: 10,
+    tenant: tenantId,
+});
+console.log(searchRes.data);
+
+// Create a flow
+const createRes = await FlowsAPI.createFlow({
+    tenant: tenantId,
+    body: `
+id: hello-world
+namespace: my.namespace
+
+tasks:
+  - id: hello
+    type: io.kestra.plugin.core.log.Log
+    message: Hello World! 🚀
+`,
+});
+console.log(createRes.data);
+```
+
+### Example: trigger an execution
+
+```ts
+import { client } from "@kestra-io/kestra-sdk/client";
+import * as ExecutionsAPI from "@kestra-io/kestra-sdk/executions";
+
+client.setConfig({
+    baseURL: "https://<your-kestra-host>",
+    auth: () => "root@root.com:Root!1234",
+});
+
+const execution = await ExecutionsAPI.createExecution({
+    tenant: "main",
+    namespace: "my.namespace",
+    id: "hello-world",
+});
+console.log(execution.data);
+```

package/dist/index.d.ts

@@ -23,7 +23,7 @@ declare const configureAxios: (clientConfig?: Config<ClientOptions$1>, options?:
       name: string;
       query?: Record<string, string>;
     }) => void;
-    beforeEach: (callback: (to: any, from: any, next: () => void) => void) => void;
+    beforeEach: (callback: (to: any, from: any) => void) => void;
     afterEach: (callback: () => void) => void;
   };
   coreStore?: {

package/dist/index.js

@@ -197,11 +197,10 @@ const configureAxios = (clientConfig = {}, options = {}) => {
 		}
 		return Promise.reject(errorResponse);
 	});
-	router?.beforeEach((_to, _from, next) => {
+	router?.beforeEach(() => {
 		if (pendingRoute) requestsTotal--;
 		pendingRoute = true;
 		initProgress();
-		next();
 	});
 	router?.afterEach(() => {
 		if (pendingRoute) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kestra-io/kestra-sdk",
-  "version": "2.0.0-dev.4bc905a7.0b725cca",
+  "version": "2.0.0-dev.4bc905a7.6706a2d2",
   "description": "All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.<br/> Endpoints designated as Superadmin-only are not tenant-scoped.",
   "license": "Unlicense",
   "type": "module",
@@ -59,7 +59,8 @@
     "dev": "node scripts/dev.mjs",
     "typecheck": "vue-tsc --noEmit",
     "generate:openapi": "openapi-ts",
-    "prebuild": "openapi-ts"
+    "prebuild": "openapi-ts",
+    "prepack": "cp ../../README_JAVASCRIPT_SDK.md README.md"
   },
   "dependencies": {
     "nprogress": "0.2.0",