@cero-base/cero 0.5.2 → 0.6.0

package/types/lib/builtins.d.ts

@@ -1,141 +0,0 @@
-/**
- * Map a schema-DSL primitive name to its HyperDB type name.
- *
- * @param {string} prim
- * @returns {string}
- */
-export function hyperdbType(prim: string): string;
-/**
- * Type descriptors registered into every main schema.
- *
- * @returns {TypeDesc[]}
- */
-export function builtinTypes(): TypeDesc[];
-/**
- * Collection descriptors for every main schema, namespaced under `ns`.
- *
- * @param {string} ns
- * @returns {CollectionDesc[]}
- */
-export function builtinCollections(ns: string): CollectionDesc[];
-/**
- * Dispatch (mutation) descriptors for every main schema, namespaced under `ns`.
- *
- * @param {string} ns
- * @returns {DispatchDesc[]}
- */
-export function builtinDispatches(ns: string): DispatchDesc[];
-/**
- * Type descriptors registered into every local schema.
- *
- * @returns {TypeDesc[]}
- */
-export function localBuiltinTypes(): TypeDesc[];
-/**
- * Collection descriptors for every local schema, namespaced under `ns`.
- *
- * @param {string} ns
- * @returns {CollectionDesc[]}
- */
-export function localBuiltinCollections(ns: string): CollectionDesc[];
-/**
- * Request/response type descriptors for the RPC facade.
- *
- * @returns {TypeDesc[]}
- */
-export function rpcTypes(): TypeDesc[];
-/**
- * RPC command (verb) descriptors for the cero server, namespaced under `ns`.
- *
- * @param {string} ns
- * @returns {CommandDesc[]}
- */
-export function rpcCommands(ns: string): CommandDesc[];
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- *
- * @typedef {{ name: string, type: string, verb?: string, kind?: string }} BuiltinRef
- * @typedef {{ name: string, type: string, required: boolean }} FieldDesc
- * @typedef {{ name: string, compact: boolean, fields: FieldDesc[] }} TypeDesc
- * @typedef {{ name: string, schema: string, key: string[] }} CollectionDesc
- * @typedef {{ name: string, requestType: string }} DispatchDesc
- * @typedef {{
- *   name: string,
- *   request: { name: string },
- *   response: { name: string, stream?: boolean }
- * }} CommandDesc
- */
-/**
- * Refs that exist on every main (Handle) schema.
- *
- * @type {BuiltinRef[]}
- */
-export const BUILTINS: BuiltinRef[];
-/**
- * Refs that exist on every local schema.
- *
- * @type {BuiltinRef[]}
- */
-export const LOCAL_BUILTINS: BuiltinRef[];
-/** Collection name for the internal counters table. */
-export const COUNTERS: "counters";
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- */
-export type BuiltinRef = {
-    name: string;
-    type: string;
-    verb?: string;
-    kind?: string;
-};
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- */
-export type FieldDesc = {
-    name: string;
-    type: string;
-    required: boolean;
-};
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- */
-export type TypeDesc = {
-    name: string;
-    compact: boolean;
-    fields: FieldDesc[];
-};
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- */
-export type CollectionDesc = {
-    name: string;
-    schema: string;
-    key: string[];
-};
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- */
-export type DispatchDesc = {
-    name: string;
-    requestType: string;
-};
-/**
- * Builtin type/collection/dispatch/rpc definitions used by the builder.
- * Every cero schema includes these; user-defined refs are added on top.
- */
-export type CommandDesc = {
-    name: string;
-    request: {
-        name: string;
-    };
-    response: {
-        name: string;
-        stream?: boolean;
-    };
-};