@appliance.sh/sdk 1.8.0 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appliance.sh/sdk",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "SDK for installing, running, and developing applications for the Appliance platform",
   "repository": "https://github.com/appliance-sh/appliance.sh",
   "license": "MIT",
@@ -10,11 +10,11 @@
   "exports": {
     "require": "./dist/cjs/index.js",
     "import": "./dist/esm/index.js",
-    "types": "./dist/types"
+    "types": "./dist/types/index.d.ts"
   },
   "types": "./dist/types",
   "scripts": {
-    "build": "tsc --module commonjs --outDir dist/cjs && tsc --moduleResolution node --module es2022 --outDir dist/esm && npm run postbuild && npm link",
+    "build": "tsc --module commonjs --outDir dist/cjs && tsc --moduleResolution nodenext --module NodeNext --outDir dist/esm && npm run postbuild && npm link",
     "clean": "rm -rf ./dist/",
     "dev:setup": "npm link",
     "postbuild": "npx ts-node scripts/postbuild.ts",

package/src/common.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+
+export const portInput = z.number().int().gt(0).lt(65536);

package/src/index.ts

@@ -1,2 +1,4 @@
 export * from './models/appliance';
 export * from './version';
+export * from './result';
+export type * from './result';

package/src/models/appliance.ts

@@ -1,21 +1,50 @@
 import { z } from 'zod';
+import { portInput } from '../common';
+
+export enum ApplianceType {
+  container = 'container',
+  framework = 'framework',
+  other = 'other',
+}
+
+export enum ApplianceFramework {
+  Auto = 'auto',
+  Python = 'python',
+  Node = 'node',
+  Other = 'other',
+}
+
+export const applianceTypeSchema = z.enum(ApplianceType);
 
 export const applianceBaseInput = z.object({
   manifest: z.literal('v1'),
   name: z.string(),
-  version: z.string(),
-  scripts: z.record(z.string(), z.string()),
+  version: z.string().optional(),
+  scripts: z.record(z.string(), z.string()).optional(),
 });
 
 export const applianceTypeContainerInput = applianceBaseInput.extend({
-  type: z.literal('container'),
+  type: z.literal(applianceTypeSchema.enum.container),
+  port: portInput,
+});
+
+export const applianceTypeFrameworkInput = applianceBaseInput.extend({
+  type: z.literal(applianceTypeSchema.enum.framework),
+  framework: z.string().optional().default('auto'),
+  port: portInput.optional(),
+  includes: z.array(z.string()).optional(),
+  excludes: z.array(z.string()).optional(),
 });
 
 export const applianceTypeOtherInput = applianceBaseInput.extend({
-  type: z.literal('other'),
+  type: z.literal(applianceTypeSchema.enum.other),
 });
 
-export const applianceInput = z.discriminatedUnion('type', [applianceTypeContainerInput, applianceTypeOtherInput]);
+export const applianceInput = z.discriminatedUnion('type', [
+  applianceTypeContainerInput,
+  applianceTypeFrameworkInput,
+  applianceTypeOtherInput,
+]);
 
 export type ApplianceInput = z.infer<typeof applianceInput>;
 export type Appliance = z.output<typeof applianceInput>;

package/src/models/deployment.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+export const deployment = z.object({
+  name: z.string(),
+  projectId: z.string(),
+  deploymentId: z.string(),
+});

package/src/result.ts

@@ -0,0 +1,4 @@
+export type Result<T> = ResultSuccess<T> | ResultError<T>;
+export type ResultSuccess<T> = { success: true; data: T; error?: never };
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export type ResultError<T> = { success: false; data?: never; error: Error };