Merge pull request #2 from FoxNoseTech/feat/add-router-and-schema-introspection

Feat: Support Flux router and schema introspection endpoints

Author: loookashow

README.md

@@ -12,6 +12,7 @@ Official TypeScript SDK for the [FoxNose](https://foxnose.net/?utm_source=github
 - **Async-only API** built on native `fetch` (Node 18+)
 - **Automatic retries** with exponential backoff and Retry-After support
 - **Four auth strategies** — Anonymous, JWT, Simple key, and Secure (ECDSA P-256)
+- **Flux introspection** — discover route contracts with `/_router` and `/_schema`
 - **Zero dependencies** — uses only Node.js built-in modules
 - **Dual output** — ESM and CommonJS builds with full `.d.ts` declarations
 
@@ -87,9 +88,32 @@ const results = await client.search('articles', {
   size: 10,
 });
 
+// Discover available routes for this API prefix
+const router = await client.getRouter();
+console.log(router.routes.length);
+
+// Get live schema metadata for a folder route
+const schema = await client.getSchema('articles');
+console.log(schema.searchable_fields);
+
 client.close();
 ```
 
+### API Folder Route Descriptions
+
+You can configure per-route descriptions when connecting a folder to an API.
+These descriptions are returned by Flux `/_router` introspection.
+
+```typescript
+await managementClient.addApiFolder(api.key, folder.key, {
+  allowedMethods: ['get_many', 'get_one'],
+  descriptionGetOne: 'Get one article by key',
+  descriptionGetMany: 'List published articles',
+  descriptionSearch: 'Search published articles',
+  descriptionSchema: 'Read article schema',
+});
+```
+
 ## Authentication
 
 The SDK supports four authentication strategies:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxnose/sdk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Official FoxNose SDK for TypeScript and JavaScript",
   "license": "Apache-2.0",
   "type": "module",

src/config.ts

@@ -19,7 +19,7 @@ export const DEFAULT_RETRY_CONFIG: Readonly<RetryConfig> = {
   methods: ['GET', 'HEAD', 'OPTIONS', 'PUT', 'DELETE'],
 };
 
-export const SDK_VERSION = '0.1.1';
+export const SDK_VERSION = '0.2.0';
 
 export const DEFAULT_USER_AGENT = `foxnose-sdk-js/${SDK_VERSION}`;
 

src/flux/client.ts

@@ -72,6 +72,16 @@ export class FluxClient {
     return this.transport.request('POST', path, { jsonBody: body });
   }
 
+  async getRouter<T = any>(): Promise<T> {
+    const path = `/${this.apiPrefix}/_router`;
+    return this.transport.request('GET', path);
+  }
+
+  async getSchema<T = any>(folderPath: string): Promise<T> {
+    const path = this.buildPath(folderPath, '/_schema');
+    return this.transport.request('GET', path);
+  }
+
   close(): void {
     this.transport.close();
   }

src/http.ts

@@ -12,11 +12,7 @@ export class HttpTransport {
   private readonly auth: AuthStrategy;
   private readonly retry: RetryConfig;
 
-  constructor(options: {
-    config: FoxnoseConfig;
-    auth?: AuthStrategy;
-    retryConfig?: RetryConfig;
-  }) {
+  constructor(options: { config: FoxnoseConfig; auth?: AuthStrategy; retryConfig?: RetryConfig }) {
     this.config = options.config;
     this.auth = options.auth ?? new AnonymousAuth();
     this.retry = options.retryConfig ?? { ...DEFAULT_RETRY_CONFIG };

src/index.ts

@@ -25,7 +25,11 @@ export { HttpTransport } from './http.js';
 
 // Management Client
 export { ManagementClient } from './management/index.js';
-export type { ManagementClientOptions } from './management/index.js';
+export type {
+  ApiFolderOptions,
+  ApiFolderRouteDescriptionOptions,
+  ManagementClientOptions,
+} from './management/index.js';
 
 // Flux Client
 export { FluxClient } from './flux/index.js';