@player-tools/xlr 0.1.0 → 0.2.0-next.0

package/dist/index.d.ts

@@ -83,10 +83,12 @@ interface ObjectProperty {
     node: NodeType;
 }
 interface ObjectNode extends TypeNode<'object'> {
-    /** the properties associated with an object */
+    /** The properties associated with an object */
     properties: {
         [name: string]: ObjectProperty;
     };
+    /** A custom primitive that this object extends that is to be resolved when used */
+    extends?: RefType;
     /** What type, if any, of additional properties are allowed on the object */
     additionalProperties: false | NodeType;
 }
@@ -160,6 +162,12 @@ declare type FunctionType = TypeNode<'function'> & Annotations & {
 declare type PrimitiveTypes = NeverType | NullType | StringType | NumberType | BooleanType | AnyType | UnknownType | UndefinedType;
 /** Set of all Node Types */
 declare type NodeType = AnyType | UnknownType | UndefinedType | NullType | NeverType | StringType | TemplateLiteralType | NumberType | BooleanType | ObjectType | ArrayType | TupleType | RecordType | AndType | OrType | RefType | FunctionType | ConditionalType;
+declare type NodeTypeStrings = Pick<NodeType, 'type'>['type'];
+declare type NodeTypeMap = {
+    [K in NodeTypeStrings]: Extract<NodeType, {
+        type: K;
+    }>;
+};
 declare type NamedType<T extends NodeType = NodeType> = T & {
     /** Name of the exported interface/type */
     name: string;
@@ -183,7 +191,7 @@ declare type NodeTypeWithGenerics<T extends NodeType = NodeType> = T & {
     genericTokens: Array<ParamTypeNode>;
 };
 
-declare type TransformFunction = (input: NamedType<NodeType>, capabilityType: string) => void;
+declare type TransformFunction = (input: NamedType<NodeType> | NodeType, capabilityType: string) => void;
 interface Capability {
     /** Name of the capability that is provided to Player */
     name: string;
@@ -205,4 +213,4 @@ interface TSManifest {
     };
 }
 
-export { AndType, Annotations, AnyType, ArrayNode, ArrayType, BooleanType, Capability, CommonTypeInfo, ConditionalNode, ConditionalType, Const, Enum, FunctionType, FunctionTypeParameters, Manifest, NamedType, NamedTypeWithGenerics, NeverType, NodeType, NodeTypeWithGenerics, NullType, NumberType, ObjectNode, ObjectProperty, ObjectType, OrType, ParamTypeNode, PrimitiveTypes, RecordType, RefNode, RefType, StringType, TSManifest, TemplateLiteralType, TransformFunction, TupleNode, TupleType, TypeMap, TypeNode, UndefinedType, UnknownType };
+export { AndType, Annotations, AnyType, ArrayNode, ArrayType, BooleanType, Capability, CommonTypeInfo, ConditionalNode, ConditionalType, Const, Enum, FunctionType, FunctionTypeParameters, Manifest, NamedType, NamedTypeWithGenerics, NeverType, NodeType, NodeTypeMap, NodeTypeStrings, NodeTypeWithGenerics, NullType, NumberType, ObjectNode, ObjectProperty, ObjectType, OrType, ParamTypeNode, PrimitiveTypes, RecordType, RefNode, RefType, StringType, TSManifest, TemplateLiteralType, TransformFunction, TupleNode, TupleType, TypeMap, TypeNode, UndefinedType, UnknownType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@player-tools/xlr",
-  "version": "0.1.0",
+  "version": "0.2.0-next.0",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"

package/src/core.ts

@@ -100,10 +100,12 @@ export interface ObjectProperty {
   node: NodeType;
 }
 export interface ObjectNode extends TypeNode<'object'> {
-  /** the properties associated with an object */
+  /** The properties associated with an object */
   properties: {
     [name: string]: ObjectProperty;
   };
+  /** A custom primitive that this object extends that is to be resolved when used */
+  extends?: RefType;
   /** What type, if any, of additional properties are allowed on the object */
   additionalProperties: false | NodeType;
 }
@@ -224,6 +226,13 @@ export type NodeType =
   | FunctionType
   | ConditionalType;
 
+export type NodeTypeStrings = Pick<NodeType, 'type'>['type'];
+
+export type NodeTypeMap = {
+  // eslint-disable-next-line jsdoc/require-jsdoc, prettier/prettier
+  [K in NodeTypeStrings]: Extract<NodeType,{type: K}>;
+};
+
 export type NamedType<T extends NodeType = NodeType> = T & {
   /** Name of the exported interface/type */
   name: string;

package/src/utility.ts

@@ -1,7 +1,7 @@
 import type { NamedType, NodeType } from '.';
 
 export type TransformFunction = (
-  input: NamedType<NodeType>,
+  input: NamedType<NodeType> | NodeType,
   capabilityType: string
 ) => void;