@xyd-js/sources 0.0.1-xyd.0

package/docs.json

@@ -0,0 +1,551 @@
+{
+  "schemaVersion": "2.0",
+  "id": 19,
+  "name": "@xyd-sources-examples/package-a",
+  "variant": "project",
+  "kind": 1,
+  "flags": {},
+  "children": [
+    {
+      "id": 20,
+      "name": "ExampleClass",
+      "variant": "declaration",
+      "kind": 128,
+      "flags": {},
+      "comment": {
+        "summary": [
+          {
+            "kind": "text",
+            "text": "Returns a personalized hello world message."
+          }
+        ]
+      },
+      "children": [
+        {
+          "id": 21,
+          "name": "constructor",
+          "variant": "declaration",
+          "kind": 512,
+          "flags": {},
+          "signatures": [
+            {
+              "id": 22,
+              "name": "ExampleClass",
+              "variant": "signature",
+              "kind": 16384,
+              "flags": {},
+              "type": {
+                "type": "reference",
+                "target": 20,
+                "name": "ExampleClass",
+                "package": "@xyd-sources-examples/package-a"
+              }
+            }
+          ]
+        },
+        {
+          "id": 23,
+          "name": "helloWorld",
+          "variant": "declaration",
+          "kind": 2048,
+          "flags": {},
+          "sources": [
+            {
+              "fileName": "index.ts",
+              "line": 36,
+              "character": 4,
+              "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L36"
+            }
+          ],
+          "signatures": [
+            {
+              "id": 24,
+              "name": "helloWorld",
+              "variant": "signature",
+              "kind": 4096,
+              "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "Returns a hello world message."
+                  }
+                ]
+              },
+              "sources": [
+                {
+                  "fileName": "index.ts",
+                  "line": 36,
+                  "character": 4,
+                  "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L36"
+                }
+              ],
+              "type": {
+                "type": "intrinsic",
+                "name": "string"
+              }
+            }
+          ]
+        }
+      ],
+      "groups": [
+        {
+          "title": "Constructors",
+          "children": [
+            21
+          ]
+        },
+        {
+          "title": "Methods",
+          "children": [
+            23
+          ]
+        }
+      ],
+      "sources": [
+        {
+          "fileName": "index.ts",
+          "line": 32,
+          "character": 13,
+          "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L32"
+        }
+      ]
+    },
+    {
+      "id": 25,
+      "name": "gqlSchemaToReferences",
+      "variant": "declaration",
+      "kind": 64,
+      "flags": {},
+      "sources": [
+        {
+          "fileName": "index.ts",
+          "line": 48,
+          "character": 16,
+          "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L48"
+        }
+      ],
+      "signatures": [
+        {
+          "id": 26,
+          "name": "gqlSchemaToReferences",
+          "variant": "signature",
+          "kind": 4096,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "Converts a GraphQL schema file to references."
+              }
+            ],
+            "blockTags": [
+              {
+                "tag": "@returns",
+                "content": [
+                  {
+                    "kind": "text",
+                    "text": "references"
+                  }
+                ]
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "index.ts",
+              "line": 48,
+              "character": 16,
+              "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L48"
+            }
+          ],
+          "parameters": [
+            {
+              "id": 27,
+              "name": "schemaLocation",
+              "variant": "param",
+              "kind": 32768,
+              "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "The location of the schema file."
+                  }
+                ]
+              },
+              "type": {
+                "type": "intrinsic",
+                "name": "string"
+              }
+            }
+          ],
+          "type": {
+            "type": "reference",
+            "target": {
+              "packageName": "typescript",
+              "packagePath": "lib/lib.es5.d.ts",
+              "qualifiedName": "Promise"
+            },
+            "typeArguments": [
+              {
+                "type": "tuple"
+              }
+            ],
+            "name": "Promise",
+            "package": "typescript"
+          }
+        }
+      ]
+    },
+    {
+      "id": 28,
+      "name": "helloWorld",
+      "variant": "declaration",
+      "kind": 64,
+      "flags": {},
+      "sources": [
+        {
+          "fileName": "index.ts",
+          "line": 4,
+          "character": 16,
+          "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L4"
+        }
+      ],
+      "signatures": [
+        {
+          "id": 29,
+          "name": "helloWorld",
+          "variant": "signature",
+          "kind": 4096,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "Returns a hello world message."
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "index.ts",
+              "line": 4,
+              "character": 16,
+              "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L4"
+            }
+          ],
+          "type": {
+            "type": "intrinsic",
+            "name": "string"
+          }
+        }
+      ]
+    },
+    {
+      "id": 30,
+      "name": "helloWorldV2",
+      "variant": "declaration",
+      "kind": 64,
+      "flags": {},
+      "sources": [
+        {
+          "fileName": "index.ts",
+          "line": 15,
+          "character": 16,
+          "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L15"
+        }
+      ],
+      "signatures": [
+        {
+          "id": 31,
+          "name": "helloWorldV2",
+          "variant": "signature",
+          "kind": 4096,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "Returns a personalized hello world message."
+              }
+            ],
+            "blockTags": [
+              {
+                "tag": "@returns",
+                "content": [
+                  {
+                    "kind": "text",
+                    "text": "A greeting message string."
+                  }
+                ]
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "index.ts",
+              "line": 15,
+              "character": 16,
+              "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L15"
+            }
+          ],
+          "parameters": [
+            {
+              "id": 32,
+              "name": "name",
+              "variant": "param",
+              "kind": 32768,
+              "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "Name of the person to greet."
+                  }
+                ]
+              },
+              "type": {
+                "type": "intrinsic",
+                "name": "string"
+              }
+            },
+            {
+              "id": 33,
+              "name": "enthusiastic",
+              "variant": "param",
+              "kind": 32768,
+              "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "If true, adds an exclamation point to the greeting."
+                  }
+                ]
+              },
+              "type": {
+                "type": "intrinsic",
+                "name": "boolean"
+              },
+              "defaultValue": "false"
+            }
+          ],
+          "type": {
+            "type": "intrinsic",
+            "name": "string"
+          }
+        }
+      ]
+    },
+    {
+      "id": 34,
+      "name": "helloWorldV3",
+      "variant": "declaration",
+      "kind": 64,
+      "flags": {},
+      "sources": [
+        {
+          "fileName": "index.ts",
+          "line": 25,
+          "character": 16,
+          "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L25"
+        }
+      ],
+      "signatures": [
+        {
+          "id": 35,
+          "name": "helloWorldV3",
+          "variant": "signature",
+          "kind": 4096,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "Returns a personalized hello world message."
+              }
+            ],
+            "blockTags": [
+              {
+                "tag": "@returns",
+                "content": [
+                  {
+                    "kind": "text",
+                    "text": "A greeting message string."
+                  }
+                ]
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "index.ts",
+              "line": 25,
+              "character": 16,
+              "url": "https://github.com/livesession/xyd/blob/a2256e77dd1fbfde54d6308224d3f41847b1b817/packages/xyd-sources/example/package-a/src/index.ts#L25"
+            }
+          ],
+          "typeParameters": [
+            {
+              "id": 36,
+              "name": "T",
+              "variant": "typeParam",
+              "kind": 131072,
+              "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "The type of the name."
+                  }
+                ]
+              }
+            }
+          ],
+          "parameters": [
+            {
+              "id": 37,
+              "name": "name",
+              "variant": "param",
+              "kind": 32768,
+              "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "Name of the person to greet."
+                  }
+                ]
+              },
+              "type": {
+                "type": "reference",
+                "target": 36,
+                "name": "T",
+                "package": "@xyd-sources-examples/package-a",
+                "refersToTypeParameter": true
+              }
+            }
+          ],
+          "type": {
+            "type": "intrinsic",
+            "name": "string"
+          }
+        }
+      ]
+    }
+  ],
+  "groups": [
+    {
+      "title": "Classes",
+      "children": [
+        20
+      ]
+    },
+    {
+      "title": "Functions",
+      "children": [
+        25,
+        28,
+        30,
+        34
+      ]
+    }
+  ],
+  "packageName": "@xyd-js/sources",
+  "symbolIdMap": {
+    "19": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": ""
+    },
+    "20": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "ExampleClass"
+    },
+    "23": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "ExampleClass.helloWorld"
+    },
+    "24": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "ExampleClass.helloWorld"
+    },
+    "25": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "gqlSchemaToReferences"
+    },
+    "26": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "gqlSchemaToReferences"
+    },
+    "27": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "schemaLocation"
+    },
+    "28": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "helloWorld"
+    },
+    "29": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "helloWorld"
+    },
+    "30": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "helloWorldV2"
+    },
+    "31": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "helloWorldV2"
+    },
+    "32": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "name"
+    },
+    "33": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "enthusiastic"
+    },
+    "34": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "helloWorldV3"
+    },
+    "35": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "helloWorldV3"
+    },
+    "36": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "T"
+    },
+    "37": {
+      "packageName": "@xyd-sources-examples/package-a",
+      "packagePath": "src/index.ts",
+      "qualifiedName": "name"
+    }
+  },
+  "files": {
+    "entries": {
+      "1": "package-a/src/index.ts"
+    },
+    "reflections": {
+      "1": 19
+    }
+  }
+}

package/example/package-a/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@xyd-sources-examples/package-a",
+  "main": "dist/index.js"
+}

package/example/package-a/src/index.ts

@@ -0,0 +1,56 @@
+/**
+ * Returns a hello world message.
+ */
+export function helloWorld(): string {
+    return 'Hello world!';
+}
+
+/**
+ * Returns a personalized hello world message.
+ *
+ * @param name - Name of the person to greet.
+ * @param enthusiastic - If true, adds an exclamation point to the greeting.
+ * @returns A greeting message string.
+ */
+export function helloWorldV2(name: string, enthusiastic: boolean = false): string {
+    return enthusiastic ? `Hello, ${name}!` : `Hello, ${name}`;
+}
+
+/**
+ * Returns a personalized hello world message.
+ * @param name - Name of the person to greet.
+ * @typeParam T - The type of the name.
+ * @returns A greeting message string.
+ */
+export function helloWorldV3<T>(name: T): string {
+    return `Hello, ${name}!`
+}
+
+/**
+ * Returns a personalized hello world message.
+ */
+export class ExampleClass {
+    /**
+     * Returns a hello world message.
+     */
+    helloWorld(): string {
+        return 'Hello world!';
+    }
+}
+
+/**
+ * Converts a GraphQL schema file to references.
+ * 
+ * @param schemaLocation - The location of the schema file.
+ * 
+ * @returns references
+ */
+export function gqlSchemaToReferences(
+    schemaLocation: string
+): Promise<[]> {
+    if (schemaLocation.endsWith(".graphql")) {
+        return Promise.resolve([])
+    }
+
+    return Promise.resolve([])
+}

package/example/package-a/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "declaration": true,
+    "declarationMap": true,
+    "incremental": true,
+    "tsBuildInfoFile": "./dist/tsconfig.tsbuildinfo"
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/example/package-b/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@xyd-sources-examples/package-b",
+  "files": [
+    "./dist"
+  ],
+  "main": "./dist/index.js"
+}