@intrig/plugin-react 0.0.1 → 0.0.2-0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intrig/plugin-react",
-  "version": "0.0.1",
+  "version": "0.0.2-0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -8,7 +8,6 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "development": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs",
@@ -16,9 +15,13 @@
     }
   },
   "dependencies": {
-    "@intrig/plugin-sdk": "^0.0.1",
+    "@intrig/plugin-sdk": "^0.0.2-0",
     "@swc/helpers": "~0.5.11"
   },
+  "files": [
+    "dist",
+    "package.json"
+  ],
   "publishConfig": {
     "access": "public"
   }

package/.swcrc

@@ -1,29 +0,0 @@
-{
-  "jsc": {
-    "target": "es2017",
-    "parser": {
-      "syntax": "typescript",
-      "decorators": true,
-      "dynamicImport": true
-    },
-    "transform": {
-      "decoratorMetadata": true,
-      "legacyDecorator": true
-    },
-    "keepClassNames": true,
-    "externalHelpers": true,
-    "loose": true
-  },
-  "module": {
-    "type": "es6"
-  },
-  "sourceMaps": true,
-  "exclude": [
-    "jest.config.ts",
-    ".*\\.spec.tsx?$",
-    ".*\\.test.tsx?$",
-    "./src/jest-setup.ts$",
-    "./**/jest-setup.ts$",
-    ".*.js$"
-  ]
-}

package/eslint.config.mjs

@@ -1,19 +0,0 @@
-import baseConfig from '../../eslint.base.config.mjs';
-
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'error',
-        {
-          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs}'],
-        },
-      ],
-    },
-    languageOptions: {
-      parser: await import('jsonc-eslint-parser'),
-    },
-  },
-];

package/project.json

@@ -1,29 +0,0 @@
-{
-  "name": "@intrig/plugin-react",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "plugins/react/src",
-  "projectType": "library",
-  "tags": ["Intrig", "react", "generator"],
-  "targets": {
-    "build": {
-      "executor": "@nx/rollup:rollup",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/plugins/react",
-        "main": "plugins/react/src/index.ts",
-        "tsConfig": "plugins/react/tsconfig.lib.json",
-        "compiler": "swc",
-        "format": ["esm", "cjs"],
-        "outputFileName": "index.js",
-        "assets": [
-          {
-            "input": "plugins/react",
-            "glob": "package.json",
-            "output": "."
-          }
-        ],
-        "rollupConfig": "plugins/react/rollup.config.cjs"
-      }
-    }
-  }
-}

package/rollup.config.cjs

@@ -1,54 +0,0 @@
-const fs = require('node:fs');
-const path = require('node:path');
-
-function getPkgJson(pkgDir) {
-  const pkgPath = path.join(pkgDir, 'package.json');
-  if (fs.existsSync(pkgPath)) {
-    return JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
-  }
-  return {};
-}
-
-const pkg = getPkgJson(__dirname);
-const rootPkg = getPkgJson(path.resolve(__dirname, '../..'));
-
-const deps = new Set([
-  ...Object.keys(pkg.dependencies || {}),
-  ...Object.keys(pkg.peerDependencies || {}),
-  ...Object.keys(rootPkg.dependencies || {}),
-  ...Object.keys(rootPkg.peerDependencies || {}),
-]);
-
-function external(id) {
-  if (id.startsWith('.') || path.isAbsolute(id)) return false; // bundle local files
-  // Treat any bare module specifier or node_modules import as external
-  if (id.includes('node_modules')) return true;
-  const [scopeOrName, maybeName] = id.split('/');
-  const name = scopeOrName && scopeOrName.startsWith('@') && maybeName ? `${scopeOrName}/${maybeName}` : scopeOrName;
-  return deps.has(name);
-}
-
-module.exports = (config) => {
-  const newConfig = { ...config };
-  if (Array.isArray(newConfig.output)) {
-    newConfig.output = newConfig.output.map((o) => ({
-      ...o,
-      // Emit all JS files under a nested 'dist' directory inside the outputPath
-      entryFileNames: o.format === 'cjs' ? 'dist/index.cjs' : 'dist/index.js',
-      chunkFileNames: o.format === 'cjs' ? 'dist/[name].cjs' : 'dist/[name].js',
-      assetFileNames: 'dist/[name][extname]',
-      exports: o.format === 'cjs' ? 'named' : undefined
-    }));
-  } else if (newConfig.output) {
-    newConfig.output = {
-      ...newConfig.output,
-      // Emit all JS files under a nested 'dist' directory inside the outputPath
-      entryFileNames: newConfig.output.format === 'cjs' ? 'dist/index.cjs' : 'dist/index.js',
-      chunkFileNames: newConfig.output.format === 'cjs' ? 'dist/[name].cjs' : 'dist/[name].js',
-      assetFileNames: 'dist/[name][extname]',
-      exports: newConfig.output.format === 'cjs' ? 'named' : undefined
-    };
-  }
-  newConfig.external = external;
-  return newConfig;
-};

package/rollup.config.mjs

@@ -1,33 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-function getPkgJson(pkgDir) {
-  const pkgPath = path.join(pkgDir, 'package.json');
-  if (fs.existsSync(pkgPath)) {
-    return JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
-  }
-  return {};
-}
-
-const pkg = getPkgJson(new URL('.', import.meta.url).pathname);
-const rootPkg = getPkgJson(path.resolve(__dirname, '../..'));
-
-const deps = new Set([
-  ...Object.keys(pkg.dependencies || {}),
-  ...Object.keys(pkg.peerDependencies || {}),
-  ...Object.keys(rootPkg.dependencies || {}),
-  ...Object.keys(rootPkg.peerDependencies || {}),
-]);
-
-function external(id) {
-  if (id.startsWith('.') || path.isAbsolute(id)) return false; // bundle local files
-  // Treat any bare module specifier or node_modules import as external
-  if (id.includes('node_modules')) return true;
-  const [scopeOrName, maybeName] = id.split('/');
-  const name = scopeOrName?.startsWith('@') && maybeName ? `${scopeOrName}/${maybeName}` : scopeOrName;
-  return deps.has(name);
-}
-
-export default () => ({
-  external,
-});

package/src/index.ts

@@ -1,2 +0,0 @@
-export { default } from './lib/plugin-react.js';
-export { createPlugin } from './lib/plugin-react.js';

package/src/lib/code-generator.ts

@@ -1,79 +0,0 @@
-import { GeneratorContext, StatsCounter } from "@intrig/plugin-sdk";
-import {InternalGeneratorContext} from "./internal-types.js";
-import { packageJsonTemplate } from "./templates/packageJson.template.js";
-import { indexTemplate } from "./templates/index.template.js";
-import { networkStateTemplate } from "./templates/network-state.template.js";
-import { contextTemplate } from "./templates/context.template.js";
-import { reactLoggerTemplate } from "./templates/logger.template.js";
-import { reactExtraTemplate } from "./templates/extra.template.js";
-import { reactMediaTypeUtilsTemplate } from "./templates/media-type-utils.template.js";
-import { typeUtilsTemplate } from "./templates/type-utils.template.js";
-import { reactTsConfigTemplate } from "./templates/tsconfig.template.js";
-import { reactSwcrcTemplate } from "./templates/swcrc.template.js";
-import { intrigMiddlewareTemplate } from "./templates/intrigMiddleware.template.js";
-
-// Provider modular templates
-import { providerMainTemplate } from "./templates/provider/main.template.js";
-import { providerHooksTemplate } from "./templates/provider/hooks.template.js";
-import { providerInterfacesTemplate } from "./templates/provider/interfaces.template.js";
-import { providerReducerTemplate } from "./templates/provider/reducer.template.js";
-import { providerAxiosConfigTemplate } from "./templates/provider/axios-config.template.js";
-import { reactIntrigProviderTemplate } from "./templates/provider/intrig-provider.template.js";
-import { reactIntrigProviderStubTemplate } from "./templates/provider/intrig-provider-stub.template.js";
-import { reactStatusTrapTemplate } from "./templates/provider/status-trap.template.js";
-import {requestHookTemplate} from "./templates/source/controller/method/requestHook.template.js";
-import {paramsTemplate} from "./templates/source/controller/method/params.template.js";
-import {asyncFunctionHookTemplate} from "./templates/source/controller/method/asyncFunctionHook.template.js";
-import {clientIndexTemplate} from "./templates/source/controller/method/clientIndex.template.js";
-import {downloadHookTemplate} from "./templates/source/controller/method/download.template.js";
-import {typeTemplate} from "./templates/source/type/typeTemplate.js";
-
-export async function generateCode(ctx: GeneratorContext): Promise<StatsCounter[]> {
-  // Root/project files
-  await ctx.dump(packageJsonTemplate());
-  await ctx.dump(reactTsConfigTemplate());
-  await ctx.dump(reactSwcrcTemplate());
-
-  // Top-level src files
-  await ctx.dump(indexTemplate());
-  await ctx.dump(networkStateTemplate());
-  await ctx.dump(contextTemplate(ctx.sources));
-  await ctx.dump(reactLoggerTemplate());
-  await ctx.dump(reactExtraTemplate());
-  await ctx.dump(reactMediaTypeUtilsTemplate());
-  await ctx.dump(typeUtilsTemplate());
-  await ctx.dump(intrigMiddlewareTemplate());
-
-  // Provider modular files (placed under src)
-  await ctx.dump(providerMainTemplate(ctx.sources));
-  await ctx.dump(providerHooksTemplate());
-  await ctx.dump(providerInterfacesTemplate(ctx.sources));
-  await ctx.dump(providerReducerTemplate());
-  await ctx.dump(providerAxiosConfigTemplate(ctx.sources));
-  await ctx.dump(reactIntrigProviderTemplate(ctx.sources));
-  await ctx.dump(reactIntrigProviderStubTemplate(ctx.sources));
-  await ctx.dump(reactStatusTrapTemplate(ctx.sources));
-
-  const potentiallyConflictingDescriptors = ctx.restDescriptors
-    .sort((a, b) => (a.data.contentType === "application/json" ? -1 : 0) - (b.data.contentType === "application/json" ? -1 : 0))
-    .filter((descriptor, index, array) => array.findIndex(other => other.data.operationId === descriptor.data.operationId) !== index)
-    .map(descriptor => descriptor.id);
-
-  const internalGeneratorContext = new InternalGeneratorContext(potentiallyConflictingDescriptors);
-
-  for (const restDescriptor of ctx.restDescriptors) {
-    await ctx.dump(requestHookTemplate(restDescriptor, internalGeneratorContext));
-    await ctx.dump(paramsTemplate(restDescriptor, internalGeneratorContext));
-    await ctx.dump(asyncFunctionHookTemplate(restDescriptor, internalGeneratorContext));
-    if (restDescriptor.data.isDownloadable) {
-      await ctx.dump(downloadHookTemplate(restDescriptor, internalGeneratorContext))
-    }
-    await ctx.dump(clientIndexTemplate([restDescriptor], internalGeneratorContext))
-  }
-
-  for (const schemaDescriptor of ctx.schemaDescriptors) {
-    ctx.dump(typeTemplate(schemaDescriptor))
-  }
-
-  return internalGeneratorContext.getCounters()
-}

package/src/lib/get-endpoint-documentation.ts

@@ -1,35 +0,0 @@
-import {ResourceDescriptor, RestData, Tab} from "@intrig/plugin-sdk";
-import {reactSseHookDocs} from "./templates/docs/sse-hook.js";
-import {reactHookDocs} from "./templates/docs/react-hook.js";
-import {reactAsyncFunctionHookDocs} from "./templates/docs/async-hook.js";
-import {reactDownloadHookDocs} from "./templates/docs/download-hook.js";
-
-export async function getEndpointDocumentation(result: ResourceDescriptor<RestData>): Promise<Tab[]> {
-
-  const tabs: Tab[] = []
-  if (result.data.responseType === 'text/event-stream') {
-    tabs.push({
-      name: 'SSE Hook',
-      content: (await reactSseHookDocs(result)).content
-    })
-  } else {
-    tabs.push({
-      name: 'Stateful Hook',
-      content: (await reactHookDocs(result)).content
-    })
-  }
-
-  tabs.push({
-    name: 'Stateless Hook',
-    content: (await reactAsyncFunctionHookDocs(result)).content
-  })
-
-  if (result.data.isDownloadable) {
-    tabs.push({
-      name: 'Download Hook',
-      content: (await reactDownloadHookDocs(result)).content
-    })
-  }
-
-  return tabs
-}

package/src/lib/get-schema-documentation.ts

@@ -1,11 +0,0 @@
-import {ResourceDescriptor, Schema, Tab} from "@intrig/plugin-sdk";
-import {schemaJsonSchemaDoc, schemaTypescriptDoc, schemaZodSchemaDoc} from "./templates/docs/schema.js";
-
-export async function getSchemaDocumentation(result: ResourceDescriptor<Schema>): Promise<Tab[]> {
-  const tabs: Tab[] = []
-  tabs.push({ name: 'Typescript Type', content: (await schemaTypescriptDoc(result)).content })
-  tabs.push({ name: 'JSON Schema', content: (await schemaJsonSchemaDoc(result)).content })
-  tabs.push({ name: 'Zod Schema', content: (await schemaZodSchemaDoc(result)).content })
-
-  return tabs
-}

package/src/lib/internal-types.ts

@@ -1,15 +0,0 @@
-import { StatsCounter } from "@intrig/plugin-sdk";
-
-export class InternalGeneratorContext {
-  private codeGenerationBreakdown: Record<string, StatsCounter> = {};
-  constructor(public readonly potentiallyConflictingDescriptors: string[]) {}
-
-  getCounter(sourceId: string) {
-    this.codeGenerationBreakdown[sourceId] = this.codeGenerationBreakdown[sourceId] || new StatsCounter(sourceId);
-    return this.codeGenerationBreakdown[sourceId];
-  }
-
-  getCounters() {
-    return [...Object.values(this.codeGenerationBreakdown)];
-  }
-}

package/src/lib/plugin-react.ts

@@ -1,22 +0,0 @@
-import {IntrigGeneratorPlugin} from '@intrig/plugin-sdk'
-import {generateCode} from "./code-generator.js";
-import {getSchemaDocumentation} from "./get-schema-documentation.js";
-import {getEndpointDocumentation} from "./get-endpoint-documentation.js";
-
-function createPlugin(): IntrigGeneratorPlugin {
-  return {
-    meta() {
-      return {
-        name: 'intrig-binding',
-        version: '0.0.1',
-        compat: '^0.0.15'
-      }
-    },
-    generate: generateCode,
-    getSchemaDocumentation,
-    getEndpointDocumentation
-  }
-}
-
-export { createPlugin };
-export default createPlugin;

package/src/lib/templates/context.template.ts

@@ -1,74 +0,0 @@
-import {IntrigSourceConfig, typescript} from "@intrig/plugin-sdk";
-import * as path from 'path'
-
-export function contextTemplate(apisToSync: IntrigSourceConfig[]) {
-  const ts = typescript(path.resolve("src", "intrig-context.ts"))
-
-  const configType = `{
-  defaults?: DefaultConfigs,
-  ${apisToSync.map(a => `${a.id}?: DefaultConfigs`).join(",\n  ")}
-  }`
-
-  return ts`
-import { NetworkAction, NetworkState } from '@intrig/react/network-state';
-import { AxiosProgressEvent, AxiosRequestConfig } from 'axios';
-import { ZodSchema, ZodType, ZodTypeDef } from 'zod';
-import { createContext, useContext, Dispatch } from 'react';
-import { DefaultConfigs } from './interfaces';
-
-type GlobalState = Record<string, NetworkState>;
-
-interface RequestType<T = any> extends AxiosRequestConfig {
-  originalData?: T; // Keeps track of the original data type.
-  key: string;
-  source: string
-}
-
-export type SchemaOf<T> = ZodType<T, ZodTypeDef, any>;
-
-/**
- * Defines the ContextType interface for managing global state, dispatching actions,
- * and holding a collection of Axios instances.
- *
- * @interface ContextType
- * @property {GlobalState} state - The global state of the application.
- * @property {Dispatch<NetworkAction<unknown>>} dispatch - The dispatch function to send network actions.
- * @property {Record<string, AxiosInstance>} axios - A record of Axios instances for making HTTP requests.
- */
-export interface ContextType {
-  state: GlobalState;
-  filteredState: GlobalState;
-  dispatch: Dispatch<NetworkAction<unknown>>;
-  configs: ${configType};
-  execute: <T>(request: RequestType, dispatch: (state: NetworkState<T>) => void, schema: SchemaOf<T> | undefined, errorSchema: SchemaOf<T> | undefined) => Promise<void>;
-}
-
-/**
- * Context object created using \`createContext\` function. Provides a way to share state, dispatch functions,
- * and axios instance across components without having to pass props down manually at every level.
- *
- * @type {ContextType}
- */
-const Context = createContext<ContextType>({
-  state: {},
-  filteredState: {},
-  dispatch() {
-    //intentionally left blank
-  },
-  configs: {},
-  async execute() {
-    //intentionally left blank
-  },
-});
-
-export function useIntrigContext() {
-  return useContext(Context);
-}
-
-export {
-  Context,
-  GlobalState,
-  RequestType,
-}
-`
-}