@adspireai/adspire-node-sdk 1.0.0

package/.github/workflows/generate-sdk.yml

@@ -0,0 +1,41 @@
+name: Generate SDK
+
+on:
+  workflow_dispatch:  # Allow manual triggering
+  schedule:
+    - cron: '0 0 * * 1'  # Weekly on Mondays at midnight
+  # You could also trigger this when your main API repo updates its OpenAPI spec
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    environment: stage
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Generate SDK
+        run: npm run generate
+        env:
+          OPENAPI_SPEC: ${{ vars.OPENAPI_SPEC }}
+      
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "chore: update SDK from latest OpenAPI spec"
+          branch: main
+
+      - name: Publish to npm
+        if: github.ref == 'refs/heads/main'
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public

package/README.md

@@ -0,0 +1 @@
+# adspire-sdk-node

package/env.example

@@ -0,0 +1 @@
+OPENAPI_SPEC=https://stage-api.adspire.ai/docs?api-docs.json

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@adspireai/adspire-node-sdk",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "setup": "cp env.example .env",
+    "generate": "ts-node scripts/generate-sdk.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@hey-api/client-fetch": "^0.12.0",
+    "@hey-api/openapi-ts": "^0.71.1",
+    "@types/node": "^22.15.30",
+    "dotenv": "^16.5.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}

package/scripts/generate-sdk.ts

@@ -0,0 +1,17 @@
+import 'dotenv/config'
+import { createClient } from '@hey-api/openapi-ts';
+
+async function main() {
+  const specUrl = process.env.OPENAPI_SPEC || ''
+  await createClient({
+    input: specUrl,
+    output: 'src',
+    plugins: ['@hey-api/client-fetch']
+  });
+  console.log('SDK generated from', specUrl);
+}
+
+main().catch((err) => {
+  console.error('Error generating SDK:', err);
+  process.exit(1);
+});

package/src/client.gen.ts

@@ -0,0 +1,18 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
+
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+
+export const client = createClient(createConfig<ClientOptions>({
+    baseUrl: 'https://stage-api.adspire.ai'
+}));

package/src/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
+export * from './sdk.gen';

package/src/sdk.gen.ts

@@ -0,0 +1,82 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, GetMeData, GetMeResponses, GetMeErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, RefreshTokenData, RefreshTokenResponses, RefreshTokenErrors } from './types.gen';
+import { client as _heyApiClient } from './client.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+
+/**
+ * Register a new user
+ * Creates a new user account and returns authentication token or success message
+ */
+export const registerUser = <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<RegisterUserResponses, RegisterUserErrors, ThrowOnError>({
+        url: '/api/auth/register',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+
+/**
+ * User login
+ * Logs in a user and returns an access token
+ */
+export const loginUser = <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<LoginUserResponses, LoginUserErrors, ThrowOnError>({
+        url: '/api/auth/login',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+
+/**
+ * Me request
+ * Returns me data
+ */
+export const getMe = <ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<GetMeResponses, GetMeErrors, ThrowOnError>({
+        url: '/api/auth/me/',
+        ...options
+    });
+};
+
+/**
+ * Log out the authenticated user
+ * Invalidates the user's token and logs them out
+ */
+export const logoutUser = <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).post<LogoutUserResponses, LogoutUserErrors, ThrowOnError>({
+        url: '/api/auth/logout',
+        ...options
+    });
+};
+
+/**
+ * Refresh JWT token
+ * Refreshes the current JWT token and returns a new one
+ */
+export const refreshToken = <ThrowOnError extends boolean = false>(options?: Options<RefreshTokenData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).post<RefreshTokenResponses, RefreshTokenErrors, ThrowOnError>({
+        url: '/api/auth/refresh',
+        ...options
+    });
+};

package/src/types.gen.ts

@@ -0,0 +1,150 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type RegisterUserData = {
+    body: {
+        name: string;
+        email: string;
+        password: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/auth/register';
+};
+
+export type RegisterUserErrors = {
+    /**
+     * Validation error
+     */
+    422: unknown;
+};
+
+export type RegisterUserResponses = {
+    /**
+     * User successfully registered
+     */
+    201: {
+        message?: string;
+        user?: {
+            id?: number;
+            name?: string;
+            email?: string;
+        };
+    };
+};
+
+export type RegisterUserResponse = RegisterUserResponses[keyof RegisterUserResponses];
+
+export type LoginUserData = {
+    body: {
+        email: string;
+        password: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/auth/login';
+};
+
+export type LoginUserErrors = {
+    /**
+     * Invalid credentials
+     */
+    401: unknown;
+    /**
+     * Validation error
+     */
+    422: unknown;
+};
+
+export type LoginUserResponses = {
+    /**
+     * Successful login
+     */
+    200: {
+        access_token?: string;
+        token_type?: string;
+        expires_in?: number;
+    };
+};
+
+export type LoginUserResponse = LoginUserResponses[keyof LoginUserResponses];
+
+export type GetMeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/auth/me/';
+};
+
+export type GetMeErrors = {
+    /**
+     * Bad request
+     */
+    400: unknown;
+    /**
+     * Resource Not Found
+     */
+    404: unknown;
+};
+
+export type GetMeResponses = {
+    /**
+     * successful operation
+     */
+    200: unknown;
+};
+
+export type LogoutUserData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/auth/logout';
+};
+
+export type LogoutUserErrors = {
+    /**
+     * Unauthenticated
+     */
+    401: unknown;
+};
+
+export type LogoutUserResponses = {
+    /**
+     * Successfully logged out
+     */
+    200: {
+        message?: string;
+    };
+};
+
+export type LogoutUserResponse = LogoutUserResponses[keyof LogoutUserResponses];
+
+export type RefreshTokenData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/auth/refresh';
+};
+
+export type RefreshTokenErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+
+export type RefreshTokenResponses = {
+    /**
+     * Token refreshed successfully
+     */
+    200: {
+        access_token?: string;
+        token_type?: string;
+        expires_in?: number;
+    };
+};
+
+export type RefreshTokenResponse = RefreshTokenResponses[keyof RefreshTokenResponses];
+
+export type ClientOptions = {
+    baseUrl: 'https://stage-api.adspire.ai' | (string & {});
+};

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": ["node"]
+  },
+  "include": ["src", "scripts"],
+  "exclude": ["node_modules", "dist"]
+}