@arrirpc/type-defs 0.70.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2024 Joshua Sosso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# type-defs
+
+Internal library for Arri RPC containing some shared common type definitions and helpers.

package/dist/index.cjs

@@ -0,0 +1,247 @@
+'use strict';
+
+const scule = require('scule');
+
+const HttpMethodValues = [
+  "get",
+  "post",
+  "put",
+  "patch",
+  "delete",
+  "head"
+];
+const isHttpMethod = (input) => {
+  if (typeof input !== "string") {
+    return false;
+  }
+  return HttpMethodValues.includes(input);
+};
+const isRpcHttpMethod = (input) => {
+  return isHttpMethod(input) && input !== "head";
+};
+const SCHEMA_VERSION = "0.0.7";
+function isAppDefinition(input) {
+  if (typeof input !== "object") {
+    return false;
+  }
+  const inputObj = input;
+  if (typeof inputObj.schemaVersion !== "string") {
+    return false;
+  }
+  if (typeof inputObj.procedures !== "object") {
+    return false;
+  }
+  if (typeof inputObj.definitions !== "object") {
+    return false;
+  }
+  return true;
+}
+function isRpcDefinitionBase(input) {
+  if (typeof input !== "object" || input === null) {
+    return false;
+  }
+  if ("params" in input && typeof input.params !== "undefined" && typeof input.params !== "string") {
+    return false;
+  }
+  if ("response" in input && typeof input.response !== "undefined" && typeof input.response !== "string") {
+    return false;
+  }
+  return "transport" in input && typeof input.transport === "string" && input.transport.length > 0 && "path" in input && typeof input.path === "string" && input.path.length > 0;
+}
+function isRpcDefinition(input) {
+  if (!isRpcDefinitionBase(input)) {
+    return false;
+  }
+  if (!("transport" in input) || typeof input.transport !== "string") {
+    return false;
+  }
+  if (input.transport === "http") {
+    return "method" in input && isRpcHttpMethod(input.method);
+  }
+  if (input.transport === "ws") {
+    return true;
+  }
+  if (input.transport.startsWith("custom:")) {
+    return true;
+  }
+  return false;
+}
+function isServiceDefinition(input) {
+  if (typeof input !== "object") {
+    return false;
+  }
+  for (const key of Object.keys(input)) {
+    if (typeof input[key] !== "object") {
+      return false;
+    }
+  }
+  return true;
+}
+function defineGeneratorPlugin(plugin) {
+  return plugin;
+}
+function createAppDefinition(input) {
+  const definitions = { ...input.definitions };
+  const procedures = {};
+  for (const key of Object.keys(input.procedures)) {
+    const def = input.procedures[key];
+    let paramName;
+    if (def.params) {
+      paramName = def.params.metadata?.id ?? scule.pascalCase(`${key.split(".").join("_")}Params`);
+      definitions[paramName] = def.params;
+    }
+    let responseName;
+    if (def.response) {
+      responseName = def.response.metadata?.id ?? scule.pascalCase(`${key.split(".").join("_")}Response`);
+      definitions[responseName] = def.response;
+    }
+    delete def.params;
+    delete def.response;
+    procedures[key] = {
+      ...def,
+      params: paramName,
+      response: responseName
+    };
+  }
+  const result = {
+    schemaVersion: "0.0.7",
+    ...input,
+    procedures,
+    definitions
+  };
+  return result;
+}
+
+function isObject(input) {
+  return typeof input === "object" && input !== null;
+}
+function isSchema(input) {
+  const allowedProperties = [
+    "metadata",
+    "nullable",
+    "type",
+    "enum",
+    "elements",
+    "values",
+    "properties",
+    "optionalProperties",
+    "strict",
+    "discriminator",
+    "mapping",
+    "ref",
+    "definitions"
+  ];
+  if (!isObject(input)) {
+    return false;
+  }
+  for (const key of Object.keys(input)) {
+    if (!allowedProperties.includes(key)) {
+      return false;
+    }
+  }
+  return true;
+}
+function isSchemaFormEmpty(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  const keys = Object.keys(input);
+  if (keys.length === 0) {
+    return true;
+  }
+  if (keys.length === 1 && "metadata" in input && typeof input.metadata === "object" && input.metadata !== null) {
+    return true;
+  }
+  return false;
+}
+const TypeValues = [
+  "boolean",
+  "float32",
+  "float64",
+  "int8",
+  "uint8",
+  "int16",
+  "uint16",
+  "int32",
+  "uint32",
+  "int64",
+  "uint64",
+  "string",
+  "timestamp"
+];
+function isSchemaFormType(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return TypeValues.includes(input.type);
+}
+function isSchemaFormEnum(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return Array.isArray(input.enum) && input.enum.every((val) => typeof val === "string");
+}
+function isSchemaFormElements(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return "elements" in input;
+}
+function isSchemaFormProperties(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  if ("properties" in input && typeof input.properties === "object" && input.properties !== null) {
+    const keys = Object.keys(input.properties);
+    if (keys[0]) {
+      return isSchema(input.properties[keys[0]]);
+    }
+    return true;
+  }
+  return false;
+}
+function isSchemaFormValues(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return "values" in input && isSchema(input.values);
+}
+function isSchemaFormDiscriminator(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  if ("discriminator" in input && typeof input.discriminator === "string" && input.discriminator.length > 0 && typeof input.mapping === "object" && input.mapping !== null) {
+    for (const key of Object.keys(input.mapping)) {
+      if (!isSchemaFormProperties(input.mapping[key])) {
+        return false;
+      }
+    }
+    return true;
+  }
+  return false;
+}
+function isSchemaFormRef(input) {
+  return typeof input === "object" && input !== null && "ref" in input && typeof input.ref === "string" && input.ref.length > 0;
+}
+
+exports.HttpMethodValues = HttpMethodValues;
+exports.SCHEMA_VERSION = SCHEMA_VERSION;
+exports.TypeValues = TypeValues;
+exports.createAppDefinition = createAppDefinition;
+exports.defineGeneratorPlugin = defineGeneratorPlugin;
+exports.isAppDefinition = isAppDefinition;
+exports.isHttpMethod = isHttpMethod;
+exports.isObject = isObject;
+exports.isRpcDefinition = isRpcDefinition;
+exports.isRpcDefinitionBase = isRpcDefinitionBase;
+exports.isRpcHttpMethod = isRpcHttpMethod;
+exports.isSchema = isSchema;
+exports.isSchemaFormDiscriminator = isSchemaFormDiscriminator;
+exports.isSchemaFormElements = isSchemaFormElements;
+exports.isSchemaFormEmpty = isSchemaFormEmpty;
+exports.isSchemaFormEnum = isSchemaFormEnum;
+exports.isSchemaFormProperties = isSchemaFormProperties;
+exports.isSchemaFormRef = isSchemaFormRef;
+exports.isSchemaFormType = isSchemaFormType;
+exports.isSchemaFormValues = isSchemaFormValues;
+exports.isServiceDefinition = isServiceDefinition;

package/dist/index.d.cts

@@ -0,0 +1,109 @@
+declare function isObject(input: unknown): input is Record<any, any>;
+interface SchemaMetadata {
+    id?: string;
+    description?: string;
+    isDeprecated?: boolean;
+}
+type Schema = SchemaFormEmpty | SchemaFormType | SchemaFormEnum | SchemaFormElements | SchemaFormProperties | SchemaFormValues | SchemaFormDiscriminator | SchemaFormRef;
+declare function isSchema(input: unknown): input is Schema;
+interface SchemaFormEmpty {
+    nullable?: boolean;
+    metadata?: SchemaMetadata;
+}
+declare function isSchemaFormEmpty(input: unknown): input is SchemaFormEmpty;
+declare const TypeValues: readonly ["boolean", "float32", "float64", "int8", "uint8", "int16", "uint16", "int32", "uint32", "int64", "uint64", "string", "timestamp"];
+type Type = (typeof TypeValues)[number];
+interface SchemaFormType extends SchemaFormEmpty {
+    type: Type;
+}
+declare function isSchemaFormType(input: unknown): input is SchemaFormType;
+interface SchemaFormEnum extends SchemaFormEmpty {
+    enum: string[];
+}
+declare function isSchemaFormEnum(input: unknown): input is SchemaFormEnum;
+interface SchemaFormElements extends SchemaFormEmpty {
+    elements: Schema;
+}
+declare function isSchemaFormElements(input: unknown): input is SchemaFormElements;
+interface SchemaFormProperties extends SchemaFormEmpty {
+    properties: Record<string, Schema>;
+    optionalProperties?: Record<string, Schema>;
+    strict?: boolean;
+}
+declare function isSchemaFormProperties(input: unknown): input is SchemaFormProperties;
+interface SchemaFormValues extends SchemaFormEmpty {
+    values: Schema;
+}
+declare function isSchemaFormValues(input: unknown): input is SchemaFormValues;
+interface SchemaFormDiscriminator extends SchemaFormEmpty {
+    discriminator: string;
+    mapping: Record<string, SchemaFormProperties>;
+}
+declare function isSchemaFormDiscriminator(input: unknown): input is SchemaFormDiscriminator;
+interface SchemaFormRef extends SchemaFormEmpty {
+    ref: string;
+}
+declare function isSchemaFormRef(input: unknown): input is SchemaFormRef;
+
+declare const HttpMethodValues: readonly ["get", "post", "put", "patch", "delete", "head"];
+type HttpMethod = (typeof HttpMethodValues)[number];
+type RpcHttpMethod = Exclude<HttpMethod, "head">;
+declare const isHttpMethod: (input: any) => input is HttpMethod;
+declare const isRpcHttpMethod: (input: any) => input is RpcHttpMethod;
+declare const SCHEMA_VERSION = "0.0.7";
+interface AppDefinition {
+    schemaVersion: typeof SCHEMA_VERSION;
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+        [key: string]: string | undefined;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    procedures: Record<string, RpcDefinition<string>>;
+    definitions: Record<string, Schema>;
+}
+declare function isAppDefinition(input: unknown): input is AppDefinition;
+interface RpcDefinitionBase<T = string> {
+    path: string;
+    params?: T;
+    response?: T;
+    description?: string;
+    isDeprecated?: boolean;
+}
+interface HttpRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: "http";
+    method: RpcHttpMethod;
+    isEventStream?: boolean;
+}
+interface WsRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: "ws";
+}
+interface CustomRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: `custom:${string}`;
+    [key: string]: unknown;
+}
+type RpcDefinition<T = string> = HttpRpcDefinition<T> | WsRpcDefinition<T> | CustomRpcDefinition<T>;
+declare function isRpcDefinitionBase(input: unknown): input is RpcDefinitionBase;
+declare function isRpcDefinition(input: unknown): input is RpcDefinition;
+interface ServiceDefinition {
+    [key: string]: RpcDefinition | ServiceDefinition;
+}
+declare function isServiceDefinition(input: any): input is ServiceDefinition;
+interface Generator<TOptions extends Record<string, any> | undefined> {
+    run: (def: AppDefinition, isDevServer?: boolean) => any;
+    options: TOptions;
+}
+type GeneratorPlugin<TOptions extends Record<string, any> | undefined> = (options: TOptions) => Generator<TOptions>;
+declare function defineGeneratorPlugin<TOptions extends Record<string, any> | undefined>(plugin: GeneratorPlugin<TOptions>): GeneratorPlugin<TOptions>;
+type RpcDefinitionHelper = RpcDefinition<SchemaFormProperties | SchemaFormDiscriminator>;
+type AppDefinitionHelper = Omit<AppDefinition, "procedures" | "definitions" | "schemaVersion"> & {
+    procedures: Record<string, RpcDefinitionHelper>;
+    definitions?: AppDefinition["definitions"];
+};
+declare function createAppDefinition(input: AppDefinitionHelper): AppDefinition;
+
+export { type AppDefinition, type CustomRpcDefinition, type Generator, type GeneratorPlugin, type HttpMethod, HttpMethodValues, type HttpRpcDefinition, type RpcDefinition, type RpcDefinitionBase, type RpcHttpMethod, SCHEMA_VERSION, type Schema, type SchemaFormDiscriminator, type SchemaFormElements, type SchemaFormEmpty, type SchemaFormEnum, type SchemaFormProperties, type SchemaFormRef, type SchemaFormType, type SchemaFormValues, type SchemaMetadata, type ServiceDefinition, type Type, TypeValues, type WsRpcDefinition, createAppDefinition, defineGeneratorPlugin, isAppDefinition, isHttpMethod, isObject, isRpcDefinition, isRpcDefinitionBase, isRpcHttpMethod, isSchema, isSchemaFormDiscriminator, isSchemaFormElements, isSchemaFormEmpty, isSchemaFormEnum, isSchemaFormProperties, isSchemaFormRef, isSchemaFormType, isSchemaFormValues, isServiceDefinition };

package/dist/index.d.mts

@@ -0,0 +1,109 @@
+declare function isObject(input: unknown): input is Record<any, any>;
+interface SchemaMetadata {
+    id?: string;
+    description?: string;
+    isDeprecated?: boolean;
+}
+type Schema = SchemaFormEmpty | SchemaFormType | SchemaFormEnum | SchemaFormElements | SchemaFormProperties | SchemaFormValues | SchemaFormDiscriminator | SchemaFormRef;
+declare function isSchema(input: unknown): input is Schema;
+interface SchemaFormEmpty {
+    nullable?: boolean;
+    metadata?: SchemaMetadata;
+}
+declare function isSchemaFormEmpty(input: unknown): input is SchemaFormEmpty;
+declare const TypeValues: readonly ["boolean", "float32", "float64", "int8", "uint8", "int16", "uint16", "int32", "uint32", "int64", "uint64", "string", "timestamp"];
+type Type = (typeof TypeValues)[number];
+interface SchemaFormType extends SchemaFormEmpty {
+    type: Type;
+}
+declare function isSchemaFormType(input: unknown): input is SchemaFormType;
+interface SchemaFormEnum extends SchemaFormEmpty {
+    enum: string[];
+}
+declare function isSchemaFormEnum(input: unknown): input is SchemaFormEnum;
+interface SchemaFormElements extends SchemaFormEmpty {
+    elements: Schema;
+}
+declare function isSchemaFormElements(input: unknown): input is SchemaFormElements;
+interface SchemaFormProperties extends SchemaFormEmpty {
+    properties: Record<string, Schema>;
+    optionalProperties?: Record<string, Schema>;
+    strict?: boolean;
+}
+declare function isSchemaFormProperties(input: unknown): input is SchemaFormProperties;
+interface SchemaFormValues extends SchemaFormEmpty {
+    values: Schema;
+}
+declare function isSchemaFormValues(input: unknown): input is SchemaFormValues;
+interface SchemaFormDiscriminator extends SchemaFormEmpty {
+    discriminator: string;
+    mapping: Record<string, SchemaFormProperties>;
+}
+declare function isSchemaFormDiscriminator(input: unknown): input is SchemaFormDiscriminator;
+interface SchemaFormRef extends SchemaFormEmpty {
+    ref: string;
+}
+declare function isSchemaFormRef(input: unknown): input is SchemaFormRef;
+
+declare const HttpMethodValues: readonly ["get", "post", "put", "patch", "delete", "head"];
+type HttpMethod = (typeof HttpMethodValues)[number];
+type RpcHttpMethod = Exclude<HttpMethod, "head">;
+declare const isHttpMethod: (input: any) => input is HttpMethod;
+declare const isRpcHttpMethod: (input: any) => input is RpcHttpMethod;
+declare const SCHEMA_VERSION = "0.0.7";
+interface AppDefinition {
+    schemaVersion: typeof SCHEMA_VERSION;
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+        [key: string]: string | undefined;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    procedures: Record<string, RpcDefinition<string>>;
+    definitions: Record<string, Schema>;
+}
+declare function isAppDefinition(input: unknown): input is AppDefinition;
+interface RpcDefinitionBase<T = string> {
+    path: string;
+    params?: T;
+    response?: T;
+    description?: string;
+    isDeprecated?: boolean;
+}
+interface HttpRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: "http";
+    method: RpcHttpMethod;
+    isEventStream?: boolean;
+}
+interface WsRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: "ws";
+}
+interface CustomRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: `custom:${string}`;
+    [key: string]: unknown;
+}
+type RpcDefinition<T = string> = HttpRpcDefinition<T> | WsRpcDefinition<T> | CustomRpcDefinition<T>;
+declare function isRpcDefinitionBase(input: unknown): input is RpcDefinitionBase;
+declare function isRpcDefinition(input: unknown): input is RpcDefinition;
+interface ServiceDefinition {
+    [key: string]: RpcDefinition | ServiceDefinition;
+}
+declare function isServiceDefinition(input: any): input is ServiceDefinition;
+interface Generator<TOptions extends Record<string, any> | undefined> {
+    run: (def: AppDefinition, isDevServer?: boolean) => any;
+    options: TOptions;
+}
+type GeneratorPlugin<TOptions extends Record<string, any> | undefined> = (options: TOptions) => Generator<TOptions>;
+declare function defineGeneratorPlugin<TOptions extends Record<string, any> | undefined>(plugin: GeneratorPlugin<TOptions>): GeneratorPlugin<TOptions>;
+type RpcDefinitionHelper = RpcDefinition<SchemaFormProperties | SchemaFormDiscriminator>;
+type AppDefinitionHelper = Omit<AppDefinition, "procedures" | "definitions" | "schemaVersion"> & {
+    procedures: Record<string, RpcDefinitionHelper>;
+    definitions?: AppDefinition["definitions"];
+};
+declare function createAppDefinition(input: AppDefinitionHelper): AppDefinition;
+
+export { type AppDefinition, type CustomRpcDefinition, type Generator, type GeneratorPlugin, type HttpMethod, HttpMethodValues, type HttpRpcDefinition, type RpcDefinition, type RpcDefinitionBase, type RpcHttpMethod, SCHEMA_VERSION, type Schema, type SchemaFormDiscriminator, type SchemaFormElements, type SchemaFormEmpty, type SchemaFormEnum, type SchemaFormProperties, type SchemaFormRef, type SchemaFormType, type SchemaFormValues, type SchemaMetadata, type ServiceDefinition, type Type, TypeValues, type WsRpcDefinition, createAppDefinition, defineGeneratorPlugin, isAppDefinition, isHttpMethod, isObject, isRpcDefinition, isRpcDefinitionBase, isRpcHttpMethod, isSchema, isSchemaFormDiscriminator, isSchemaFormElements, isSchemaFormEmpty, isSchemaFormEnum, isSchemaFormProperties, isSchemaFormRef, isSchemaFormType, isSchemaFormValues, isServiceDefinition };

package/dist/index.d.ts

@@ -0,0 +1,109 @@
+declare function isObject(input: unknown): input is Record<any, any>;
+interface SchemaMetadata {
+    id?: string;
+    description?: string;
+    isDeprecated?: boolean;
+}
+type Schema = SchemaFormEmpty | SchemaFormType | SchemaFormEnum | SchemaFormElements | SchemaFormProperties | SchemaFormValues | SchemaFormDiscriminator | SchemaFormRef;
+declare function isSchema(input: unknown): input is Schema;
+interface SchemaFormEmpty {
+    nullable?: boolean;
+    metadata?: SchemaMetadata;
+}
+declare function isSchemaFormEmpty(input: unknown): input is SchemaFormEmpty;
+declare const TypeValues: readonly ["boolean", "float32", "float64", "int8", "uint8", "int16", "uint16", "int32", "uint32", "int64", "uint64", "string", "timestamp"];
+type Type = (typeof TypeValues)[number];
+interface SchemaFormType extends SchemaFormEmpty {
+    type: Type;
+}
+declare function isSchemaFormType(input: unknown): input is SchemaFormType;
+interface SchemaFormEnum extends SchemaFormEmpty {
+    enum: string[];
+}
+declare function isSchemaFormEnum(input: unknown): input is SchemaFormEnum;
+interface SchemaFormElements extends SchemaFormEmpty {
+    elements: Schema;
+}
+declare function isSchemaFormElements(input: unknown): input is SchemaFormElements;
+interface SchemaFormProperties extends SchemaFormEmpty {
+    properties: Record<string, Schema>;
+    optionalProperties?: Record<string, Schema>;
+    strict?: boolean;
+}
+declare function isSchemaFormProperties(input: unknown): input is SchemaFormProperties;
+interface SchemaFormValues extends SchemaFormEmpty {
+    values: Schema;
+}
+declare function isSchemaFormValues(input: unknown): input is SchemaFormValues;
+interface SchemaFormDiscriminator extends SchemaFormEmpty {
+    discriminator: string;
+    mapping: Record<string, SchemaFormProperties>;
+}
+declare function isSchemaFormDiscriminator(input: unknown): input is SchemaFormDiscriminator;
+interface SchemaFormRef extends SchemaFormEmpty {
+    ref: string;
+}
+declare function isSchemaFormRef(input: unknown): input is SchemaFormRef;
+
+declare const HttpMethodValues: readonly ["get", "post", "put", "patch", "delete", "head"];
+type HttpMethod = (typeof HttpMethodValues)[number];
+type RpcHttpMethod = Exclude<HttpMethod, "head">;
+declare const isHttpMethod: (input: any) => input is HttpMethod;
+declare const isRpcHttpMethod: (input: any) => input is RpcHttpMethod;
+declare const SCHEMA_VERSION = "0.0.7";
+interface AppDefinition {
+    schemaVersion: typeof SCHEMA_VERSION;
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+        [key: string]: string | undefined;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    procedures: Record<string, RpcDefinition<string>>;
+    definitions: Record<string, Schema>;
+}
+declare function isAppDefinition(input: unknown): input is AppDefinition;
+interface RpcDefinitionBase<T = string> {
+    path: string;
+    params?: T;
+    response?: T;
+    description?: string;
+    isDeprecated?: boolean;
+}
+interface HttpRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: "http";
+    method: RpcHttpMethod;
+    isEventStream?: boolean;
+}
+interface WsRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: "ws";
+}
+interface CustomRpcDefinition<T = string> extends RpcDefinitionBase<T> {
+    transport: `custom:${string}`;
+    [key: string]: unknown;
+}
+type RpcDefinition<T = string> = HttpRpcDefinition<T> | WsRpcDefinition<T> | CustomRpcDefinition<T>;
+declare function isRpcDefinitionBase(input: unknown): input is RpcDefinitionBase;
+declare function isRpcDefinition(input: unknown): input is RpcDefinition;
+interface ServiceDefinition {
+    [key: string]: RpcDefinition | ServiceDefinition;
+}
+declare function isServiceDefinition(input: any): input is ServiceDefinition;
+interface Generator<TOptions extends Record<string, any> | undefined> {
+    run: (def: AppDefinition, isDevServer?: boolean) => any;
+    options: TOptions;
+}
+type GeneratorPlugin<TOptions extends Record<string, any> | undefined> = (options: TOptions) => Generator<TOptions>;
+declare function defineGeneratorPlugin<TOptions extends Record<string, any> | undefined>(plugin: GeneratorPlugin<TOptions>): GeneratorPlugin<TOptions>;
+type RpcDefinitionHelper = RpcDefinition<SchemaFormProperties | SchemaFormDiscriminator>;
+type AppDefinitionHelper = Omit<AppDefinition, "procedures" | "definitions" | "schemaVersion"> & {
+    procedures: Record<string, RpcDefinitionHelper>;
+    definitions?: AppDefinition["definitions"];
+};
+declare function createAppDefinition(input: AppDefinitionHelper): AppDefinition;
+
+export { type AppDefinition, type CustomRpcDefinition, type Generator, type GeneratorPlugin, type HttpMethod, HttpMethodValues, type HttpRpcDefinition, type RpcDefinition, type RpcDefinitionBase, type RpcHttpMethod, SCHEMA_VERSION, type Schema, type SchemaFormDiscriminator, type SchemaFormElements, type SchemaFormEmpty, type SchemaFormEnum, type SchemaFormProperties, type SchemaFormRef, type SchemaFormType, type SchemaFormValues, type SchemaMetadata, type ServiceDefinition, type Type, TypeValues, type WsRpcDefinition, createAppDefinition, defineGeneratorPlugin, isAppDefinition, isHttpMethod, isObject, isRpcDefinition, isRpcDefinitionBase, isRpcHttpMethod, isSchema, isSchemaFormDiscriminator, isSchemaFormElements, isSchemaFormEmpty, isSchemaFormEnum, isSchemaFormProperties, isSchemaFormRef, isSchemaFormType, isSchemaFormValues, isServiceDefinition };

package/dist/index.mjs

@@ -0,0 +1,225 @@
+import { pascalCase } from 'scule';
+
+const HttpMethodValues = [
+  "get",
+  "post",
+  "put",
+  "patch",
+  "delete",
+  "head"
+];
+const isHttpMethod = (input) => {
+  if (typeof input !== "string") {
+    return false;
+  }
+  return HttpMethodValues.includes(input);
+};
+const isRpcHttpMethod = (input) => {
+  return isHttpMethod(input) && input !== "head";
+};
+const SCHEMA_VERSION = "0.0.7";
+function isAppDefinition(input) {
+  if (typeof input !== "object") {
+    return false;
+  }
+  const inputObj = input;
+  if (typeof inputObj.schemaVersion !== "string") {
+    return false;
+  }
+  if (typeof inputObj.procedures !== "object") {
+    return false;
+  }
+  if (typeof inputObj.definitions !== "object") {
+    return false;
+  }
+  return true;
+}
+function isRpcDefinitionBase(input) {
+  if (typeof input !== "object" || input === null) {
+    return false;
+  }
+  if ("params" in input && typeof input.params !== "undefined" && typeof input.params !== "string") {
+    return false;
+  }
+  if ("response" in input && typeof input.response !== "undefined" && typeof input.response !== "string") {
+    return false;
+  }
+  return "transport" in input && typeof input.transport === "string" && input.transport.length > 0 && "path" in input && typeof input.path === "string" && input.path.length > 0;
+}
+function isRpcDefinition(input) {
+  if (!isRpcDefinitionBase(input)) {
+    return false;
+  }
+  if (!("transport" in input) || typeof input.transport !== "string") {
+    return false;
+  }
+  if (input.transport === "http") {
+    return "method" in input && isRpcHttpMethod(input.method);
+  }
+  if (input.transport === "ws") {
+    return true;
+  }
+  if (input.transport.startsWith("custom:")) {
+    return true;
+  }
+  return false;
+}
+function isServiceDefinition(input) {
+  if (typeof input !== "object") {
+    return false;
+  }
+  for (const key of Object.keys(input)) {
+    if (typeof input[key] !== "object") {
+      return false;
+    }
+  }
+  return true;
+}
+function defineGeneratorPlugin(plugin) {
+  return plugin;
+}
+function createAppDefinition(input) {
+  const definitions = { ...input.definitions };
+  const procedures = {};
+  for (const key of Object.keys(input.procedures)) {
+    const def = input.procedures[key];
+    let paramName;
+    if (def.params) {
+      paramName = def.params.metadata?.id ?? pascalCase(`${key.split(".").join("_")}Params`);
+      definitions[paramName] = def.params;
+    }
+    let responseName;
+    if (def.response) {
+      responseName = def.response.metadata?.id ?? pascalCase(`${key.split(".").join("_")}Response`);
+      definitions[responseName] = def.response;
+    }
+    delete def.params;
+    delete def.response;
+    procedures[key] = {
+      ...def,
+      params: paramName,
+      response: responseName
+    };
+  }
+  const result = {
+    schemaVersion: "0.0.7",
+    ...input,
+    procedures,
+    definitions
+  };
+  return result;
+}
+
+function isObject(input) {
+  return typeof input === "object" && input !== null;
+}
+function isSchema(input) {
+  const allowedProperties = [
+    "metadata",
+    "nullable",
+    "type",
+    "enum",
+    "elements",
+    "values",
+    "properties",
+    "optionalProperties",
+    "strict",
+    "discriminator",
+    "mapping",
+    "ref",
+    "definitions"
+  ];
+  if (!isObject(input)) {
+    return false;
+  }
+  for (const key of Object.keys(input)) {
+    if (!allowedProperties.includes(key)) {
+      return false;
+    }
+  }
+  return true;
+}
+function isSchemaFormEmpty(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  const keys = Object.keys(input);
+  if (keys.length === 0) {
+    return true;
+  }
+  if (keys.length === 1 && "metadata" in input && typeof input.metadata === "object" && input.metadata !== null) {
+    return true;
+  }
+  return false;
+}
+const TypeValues = [
+  "boolean",
+  "float32",
+  "float64",
+  "int8",
+  "uint8",
+  "int16",
+  "uint16",
+  "int32",
+  "uint32",
+  "int64",
+  "uint64",
+  "string",
+  "timestamp"
+];
+function isSchemaFormType(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return TypeValues.includes(input.type);
+}
+function isSchemaFormEnum(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return Array.isArray(input.enum) && input.enum.every((val) => typeof val === "string");
+}
+function isSchemaFormElements(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return "elements" in input;
+}
+function isSchemaFormProperties(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  if ("properties" in input && typeof input.properties === "object" && input.properties !== null) {
+    const keys = Object.keys(input.properties);
+    if (keys[0]) {
+      return isSchema(input.properties[keys[0]]);
+    }
+    return true;
+  }
+  return false;
+}
+function isSchemaFormValues(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  return "values" in input && isSchema(input.values);
+}
+function isSchemaFormDiscriminator(input) {
+  if (!isObject(input)) {
+    return false;
+  }
+  if ("discriminator" in input && typeof input.discriminator === "string" && input.discriminator.length > 0 && typeof input.mapping === "object" && input.mapping !== null) {
+    for (const key of Object.keys(input.mapping)) {
+      if (!isSchemaFormProperties(input.mapping[key])) {
+        return false;
+      }
+    }
+    return true;
+  }
+  return false;
+}
+function isSchemaFormRef(input) {
+  return typeof input === "object" && input !== null && "ref" in input && typeof input.ref === "string" && input.ref.length > 0;
+}
+
+export { HttpMethodValues, SCHEMA_VERSION, TypeValues, createAppDefinition, defineGeneratorPlugin, isAppDefinition, isHttpMethod, isObject, isRpcDefinition, isRpcDefinitionBase, isRpcHttpMethod, isSchema, isSchemaFormDiscriminator, isSchemaFormElements, isSchemaFormEmpty, isSchemaFormEnum, isSchemaFormProperties, isSchemaFormRef, isSchemaFormType, isSchemaFormValues, isServiceDefinition };

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@arrirpc/type-defs",
+  "type": "module",
+  "license": "MIT",
+  "author": {
+    "name": "joshmossas",
+    "url": "https://github.com/joshmossas"
+  },
+  "bugs": {
+    "url": "https://github.com/modiimedia/arri/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modiimedia/arri.git",
+    "directory": "tooling/type-defs"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "version": "0.70.0",
+  "dependencies": {
+    "scule": "^1.3.0"
+  }
+}