Road to R27 [NA2]

README.md

@@ -75,4 +75,5 @@ const unregister = poly.myWebhookContext.paymentReceieved(event => {
 unregister();
 ```
 
-Happy hacking!
+Happy hacking!
+.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "polyapi",
-  "version": "0.24.20",
+  "version": "0.25.7",
   "description": "Poly is a CLI tool to help create and manage your Poly definitions.",
   "license": "MIT",
   "repository": {
@@ -51,7 +51,7 @@
     "@typescript-eslint/eslint-plugin": "8.32.1",
     "@typescript-eslint/parser": "8.32.1",
     "adm-zip": "0.5.16",
-    "axios": "1.8.3",
+    "axios": "1.12.0",
     "chalk": "4.1.2",
     "comment-json": "4.2.3",
     "dotenv": "16.0.3",

src/api.ts

@@ -98,7 +98,8 @@ export const createOrUpdateServerFunction = async (
   code: string,
   visibility: string,
   typeSchemas: Record<string, any>,
-  requirements: string[],
+  externalDependencies: Record<string, string> | undefined,
+  internalDependencies: Record<string, Array<{ path: string; id: string }>> | undefined,
   other?: Record<string, any>,
   executionApiKey?: string,
 ) => {
@@ -112,7 +113,10 @@ export const createOrUpdateServerFunction = async (
         code,
         visibility,
         typeSchemas,
-        requirements,
+        // Keeping backwards compatability on requirements
+        requirements: externalDependencies ? Object.keys(externalDependencies) : null,
+        externalDependencies,
+        internalDependencies,
         executionApiKey,
         ...other,
       },
@@ -177,6 +181,8 @@ export const createOrUpdateClientFunction = async (
   code: string,
   visibility: string,
   typeSchemas: Record<string, any>,
+  externalDependencies: Record<string, string> | undefined,
+  internalDependencies: Record<string, Array<{ path: string; id: string }>> | undefined,
   other?: Record<string, any>,
 ) => {
   return (
@@ -189,6 +195,8 @@ export const createOrUpdateClientFunction = async (
         code,
         visibility,
         typeSchemas,
+        externalDependencies,
+        internalDependencies,
         ...other,
       },
       {

src/cli.ts

@@ -71,10 +71,11 @@ void yargs
           demandOption: false,
           type: 'string',
         },
-        functionIds: {
-          describe: 'Function IDs to generate',
+        ids: {
+          describe: 'Resource IDs to generate',
           demandOption: false,
           type: 'string',
+          alias: 'functionIds',
         },
         customPath: {
           describe: 'Custom path to .poly directory (internal use only)',
@@ -93,7 +94,7 @@ void yargs
       exitWhenNoConfig,
       contexts,
       names,
-      functionIds,
+      ids,
       customPath = DEFAULT_POLY_PATH,
       noTypes = false,
     }) => {
@@ -113,7 +114,7 @@ void yargs
         polyPath: customPath,
         contexts: contexts?.split(','),
         names: names?.split(','),
-        functionIds: functionIds?.split(','),
+        ids: ids?.split(','),
         noTypes,
       });
     },

src/commands/function.ts

@@ -79,15 +79,15 @@ export const addOrUpdateCustomFunction = async (
     }
 
     const typeSchemas = generateTypeSchemas(file, DeployableTypeEntries.map(d => d[0]), name);
+    const [externalDependencies, internalDependencies] = await getDependencies(code, file, tsConfigBaseUrl);
 
     if (server) {
       shell.echo(
         '-n',
         `${updating ? 'Updating' : 'Adding'} custom server side function...`,
       );
 
-      const dependencies = getDependencies(code, file, tsConfigBaseUrl);
-      if (dependencies.length) {
+      if (externalDependencies) {
         shell.echo(
           chalk.yellow(
             'Please note that deploying your functions will take a few minutes because it makes use of libraries other than polyapi.',
@@ -106,7 +106,8 @@ export const addOrUpdateCustomFunction = async (
         code,
         visibility,
         typeSchemas,
-        dependencies,
+        externalDependencies,
+        internalDependencies,
         other,
         executionApiKey,
       );
@@ -142,14 +143,16 @@ export const addOrUpdateCustomFunction = async (
         code,
         visibility,
         typeSchemas,
+        externalDependencies,
+        internalDependencies,
       );
       shell.echo(chalk.green('DONE'));
       shell.echo(`Client Function ID: ${customFunction.id}`);
     }
 
     await generateSingleCustomFunction(polyPath, customFunction.id, updating);
   } catch (e) {
-    shell.echo(chalk.red('ERROR\n'));
-    shell.echo(`${e.response?.data?.message || e.message}`);
+    shell.echo(chalk.redBright('ERROR\n'));
+    shell.echo(chalk.red((e instanceof Error ? e.message : e.response?.data?.message) || 'Unexpected error.'));
   }
 };

src/commands/generate/index.ts

@@ -8,6 +8,7 @@ import {
   ApiFunctionSpecification,
   AuthFunctionSpecification,
   CustomFunctionSpecification,
+  GraphQLSubscriptionSpecification,
   ServerFunctionSpecification,
   ServerVariableSpecification,
   Specification,
@@ -17,10 +18,9 @@ import {
 import { getSpecs } from '../../api';
 import { loadConfig, addOrUpdateConfig } from '../../config';
 import {
-  generateContextDataFile,
-  getContextDataFileContent,
+  writeCachedSpecs,
+  getCachedSpecs,
   getPolyLibPath,
-  getSpecsFromContextData,
   showErrGettingSpecs,
   getStringPaths,
   loadTemplate,
@@ -53,15 +53,17 @@ const getApiBaseUrl = () =>
 
 const getApiKey = () => process.env.POLY_API_KEY;
 
-const prepareDir = async (polyPath: string) => {
-  const libPath = getPolyLibPath(polyPath);
+const prepareDir = async (polyPath: string, temp = false) => {
+  let libPath = getPolyLibPath(polyPath);
+  if (temp) libPath = libPath.replace('/lib', '/temp');
 
   fs.rmSync(libPath, { recursive: true, force: true });
   fs.mkdirSync(libPath, { recursive: true });
   fs.mkdirSync(`${libPath}/api`);
   fs.mkdirSync(`${libPath}/client`);
   fs.mkdirSync(`${libPath}/auth`);
   fs.mkdirSync(`${libPath}/webhooks`);
+  fs.mkdirSync(`${libPath}/subscriptions`);
   fs.mkdirSync(`${libPath}/server`);
   fs.mkdirSync(`${libPath}/vari`);
   fs.mkdirSync(`${libPath}/tabi`);
@@ -144,6 +146,9 @@ const generateJSFiles = async (
   const tables = specs.filter(
     (spec) => spec.type === 'table',
   ) as TableSpecification[];
+  const gqlSubscriptions = specs.filter(
+    (spec) => spec.type === 'graphqlSubscription',
+  ) as GraphQLSubscriptionSpecification[];
 
   await generateIndexJSFile(libPath);
   await generatePolyCustomJSFile(libPath);
@@ -158,6 +163,7 @@ const generateJSFiles = async (
     'custom functions',
   );
   await tryAsync(generateWebhooksJSFiles(libPath, webhookHandles), 'webhooks');
+  await tryAsync(generateGraphQLSubscriptionJSFiles(libPath, gqlSubscriptions), 'GraphQL subscriptions');
   await tryAsync(
     generateAuthFunctionJSFiles(libPath, authFunctions),
     'auth functions',
@@ -284,6 +290,21 @@ const generateWebhooksJSFiles = async (
   fs.copyFileSync(templateUrl('webhooks-index.js'), `${libPath}/webhooks/index.js`);
 };
 
+const generateGraphQLSubscriptionJSFiles = async (
+  libPath: string,
+  specifications: GraphQLSubscriptionSpecification[],
+) => {
+  const template = handlebars.compile(loadTemplate('graphql-subscriptions.js.hbs'));
+  fs.writeFileSync(
+    `${libPath}/subscriptions/subscriptions.js`,
+    template({
+      specifications,
+      apiKey: getApiKey(),
+    }),
+  );
+  fs.copyFileSync(templateUrl('graphql-subscriptions-index.js'), `${libPath}/subscriptions/index.js`);
+}
+
 const generateServerFunctionJSFiles = async (
   libPath: string,
   specifications: ServerFunctionSpecification[],
@@ -441,11 +462,11 @@ const generateSingleCustomFunction = async (
     updated ? 'Regenerating TypeScript SDK...' : 'Generating TypeScript SDK...',
   );
 
-  const libPath = getPolyLibPath(polyPath);
-  let contextData: Record<string, any> = {};
+  let libPath = getPolyLibPath(polyPath);
+  let prevSpecs: Specification[] = [];
 
   try {
-    contextData = getContextDataFileContent(libPath);
+    prevSpecs = getCachedSpecs(libPath);
   } catch (error) {
     shell.echo(chalk.red('ERROR'));
     shell.echo('Error while fetching local context data.');
@@ -454,8 +475,6 @@ const generateSingleCustomFunction = async (
     return;
   }
 
-  const prevSpecs = getSpecsFromContextData(contextData);
-
   let specs: Specification[] = [];
 
   try {
@@ -479,11 +498,18 @@ const generateSingleCustomFunction = async (
     specs = prevSpecs;
   }
 
-  await prepareDir(polyPath);
+  await prepareDir(polyPath, true);
+  libPath = getPolyLibPath(polyPath);
+  const tempPath = libPath.replace('/lib', '/temp');
+
+  writeCachedSpecs(tempPath, specs);
 
   setGenerationErrors(false);
 
-  await generateSpecs(libPath, specs, noTypes);
+  await generateSpecs(tempPath, specs, noTypes);
+  // Now remove old lib and rename temp directory to force a switchover in typescript
+  fs.rmSync(libPath, { recursive: true, force: true });
+  fs.renameSync(tempPath, libPath);
 
   if (getGenerationErrors()) {
     shell.echo(
@@ -532,13 +558,13 @@ const generate = async ({
   polyPath,
   contexts,
   names,
-  functionIds,
+  ids,
   noTypes,
 }: {
   polyPath: string;
   contexts?: string[];
   names?: string[];
-  functionIds?: string[];
+  ids?: string[];
   noTypes: boolean;
 }) => {
   let specs: Specification[] = [];
@@ -548,20 +574,26 @@ const generate = async ({
     : 'Generating Poly TypeScript SDK...';
   shell.echo('-n', generateMsg);
 
-  await prepareDir(polyPath);
+  await prepareDir(polyPath, true);
   loadConfig(polyPath);
 
-  try {
-    specs = await getSpecs(contexts, names, functionIds, noTypes);
+  const libPath = getPolyLibPath(polyPath);
+  const tempPath = libPath.replace('/lib', '/temp');
 
-    updateLocalConfig(polyPath, contexts, names, functionIds, noTypes);
+  try {
+    specs = await getSpecs(contexts, names, ids, noTypes);
+    writeCachedSpecs(tempPath, specs);
+    updateLocalConfig(polyPath, contexts, names, ids, noTypes);
   } catch (error) {
     showErrGettingSpecs(error);
     return;
   }
 
   setGenerationErrors(false);
-  await generateSpecs(getPolyLibPath(polyPath), specs, noTypes);
+  await generateSpecs(tempPath, specs, noTypes);
+  // Now remove old lib and rename temp directory to force a switchover in typescript
+  fs.rmSync(libPath, { recursive: true, force: true });
+  fs.renameSync(tempPath, libPath);
 
   if (getGenerationErrors()) {
     shell.echo(
@@ -638,8 +670,6 @@ export const generateSpecs = async (
       );
     }
 
-    generateContextDataFile(libPath, filteredSpecs);
-
     if (missingNames.length) {
       setGenerationErrors(true);
       missingNames.map((s) => echoGenerationError(s));

src/commands/generate/schemaTypes.ts

@@ -558,7 +558,7 @@ const printSchemaTreeAsTypes = (
           depth + 1,
         );
       } catch (err) {
-        console.error(err);
+        shell.echo(chalk.red(err));
         echoGenerationError(child as SchemaSpec);
         setGenerationErrors(true);
       }