Add program to link nodes and update LinkableDictionary (#180)

Author: lorisleiva

.changeset/tough-grapes-give.md

@@ -0,0 +1,9 @@
+---
+'@kinobi-so/visitors-core': minor
+'@kinobi-so/node-types': minor
+'@kinobi-so/nodes': minor
+'@kinobi-so/visitors': patch
+'@kinobi-so/errors': patch
+---
+
+Add optional `program` attribute to link nodes and namespace linkable nodes under their associated program.

packages/errors/src/context.ts

@@ -75,6 +75,7 @@ export type KinobiErrorContext = DefaultUnspecifiedErrorContextToUndefined<{
         kind: LinkNode['kind'];
         linkNode: LinkNode;
         name: CamelCaseString;
+        program?: CamelCaseString;
     };
     [KINOBI_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE]: {
         fsFunction: string;

packages/node-types/src/linkNodes/AccountLinkNode.ts

@@ -1,8 +1,12 @@
 import type { CamelCaseString } from '../shared';
+import type { ProgramLinkNode } from './ProgramLinkNode';
 
-export interface AccountLinkNode {
+export interface AccountLinkNode<TProgram extends ProgramLinkNode | undefined = ProgramLinkNode | undefined> {
     readonly kind: 'accountLinkNode';
 
+    // Children.
+    readonly program?: TProgram;
+
     // Data.
     readonly name: CamelCaseString;
 }

packages/node-types/src/linkNodes/DefinedTypeLinkNode.ts

@@ -1,8 +1,12 @@
 import type { CamelCaseString } from '../shared';
+import type { ProgramLinkNode } from './ProgramLinkNode';
 
-export interface DefinedTypeLinkNode {
+export interface DefinedTypeLinkNode<TProgram extends ProgramLinkNode | undefined = ProgramLinkNode | undefined> {
     readonly kind: 'definedTypeLinkNode';
 
+    // Children.
+    readonly program?: TProgram;
+
     // Data.
     readonly name: CamelCaseString;
 }

packages/node-types/src/linkNodes/PdaLinkNode.ts

@@ -1,8 +1,12 @@
 import type { CamelCaseString } from '../shared';
+import type { ProgramLinkNode } from './ProgramLinkNode';
 
-export interface PdaLinkNode {
+export interface PdaLinkNode<TProgram extends ProgramLinkNode | undefined = ProgramLinkNode | undefined> {
     readonly kind: 'pdaLinkNode';
 
+    // Children.
+    readonly program?: TProgram;
+
     // Data.
     readonly name: CamelCaseString;
 }

packages/nodes/docs/linkNodes/AccountLinkNode.md

@@ -13,14 +13,17 @@ This node represents a reference to an existing [`AccountNode`](../AccountNode.m
 
 ### Children
 
-_This node has no children._
+| Attribute | Type                                      | Description                                                                                                     |
+| --------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| `program` | [`ProgramLinkNode`](./ProgramLinkNode.md) | (Optional) The program associated with the linked account. Default to using the program we are currently under. |
 
 ## Functions
 
-### `accountLinkNode(name)`
+### `accountLinkNode(name, program?)`
 
-Helper function that creates a `AccountLinkNode` object from the name of the `AccountNode` we are referring to.
+Helper function that creates a `AccountLinkNode` object from the name of the `AccountNode` we are referring to. If the account is from another program, the `program` parameter must be provided as either a `string` or a `ProgramLinkNode`.
 
 ```ts
 const node = accountLinkNode('myAccount');
+const nodeFromAnotherProgram = accountLinkNode('myAccount', 'myOtherProgram');
 ```

packages/nodes/docs/linkNodes/DefinedTypeLinkNode.md

@@ -13,14 +13,17 @@ This node represents a reference to an existing [`DefinedTypeNode`](../DefinedTy
 
 ### Children
 
-_This node has no children._
+| Attribute | Type                                      | Description                                                                                                  |
+| --------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| `program` | [`ProgramLinkNode`](./ProgramLinkNode.md) | (Optional) The program associated with the linked type. Default to using the program we are currently under. |
 
 ## Functions
 
-### `definedTypeLinkNode(name)`
+### `definedTypeLinkNode(name, program?)`
 
-Helper function that creates a `DefinedTypeLinkNode` object from the name of the `DefinedTypeNode` we are referring to.
+Helper function that creates a `DefinedTypeLinkNode` object from the name of the `DefinedTypeNode` we are referring to. If the defined type is from another program, the `program` parameter must be provided as either a `string` or a `ProgramLinkNode`.
 
 ```ts
 const node = definedTypeLinkNode('myDefinedType');
+const nodeFromAnotherProgram = definedTypeLinkNode('myDefinedType', 'myOtherProgram');
 ```

packages/nodes/docs/linkNodes/PdaLinkNode.md

@@ -13,14 +13,17 @@ This node represents a reference to an existing [`PdaNode`](../PdaNode.md) in th
 
 ### Children
 
-_This node has no children._
+| Attribute | Type                                      | Description                                                                                                 |
+| --------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| `program` | [`ProgramLinkNode`](./ProgramLinkNode.md) | (Optional) The program associated with the linked PDA. Default to using the program we are currently under. |
 
 ## Functions
 
-### `pdaLinkNode(name)`
+### `pdaLinkNode(name, program?)`
 
-Helper function that creates a `PdaLinkNode` object from the name of the `PdaNode` we are referring to.
+Helper function that creates a `PdaLinkNode` object from the name of the `PdaNode` we are referring to. If the PDA is from another program, the `program` parameter must be provided as either a `string` or a `ProgramLinkNode`.
 
 ```ts
 const node = pdaLinkNode('myPda');
+const nodeFromAnotherProgram = pdaLinkNode('myPda', 'myOtherProgram');
 ```

packages/nodes/src/linkNodes/AccountLinkNode.ts

@@ -1,11 +1,15 @@
-import type { AccountLinkNode } from '@kinobi-so/node-types';
+import type { AccountLinkNode, ProgramLinkNode } from '@kinobi-so/node-types';
 
 import { camelCase } from '../shared';
+import { programLinkNode } from './ProgramLinkNode';
 
-export function accountLinkNode(name: string): AccountLinkNode {
+export function accountLinkNode(name: string, program?: ProgramLinkNode | string): AccountLinkNode {
     return Object.freeze({
         kind: 'accountLinkNode',
 
+        // Children.
+        ...(program === undefined ? {} : { program: typeof program === 'string' ? programLinkNode(program) : program }),
+
         // Data.
         name: camelCase(name),
     });

packages/nodes/src/linkNodes/DefinedTypeLinkNode.ts

@@ -1,11 +1,15 @@
-import type { DefinedTypeLinkNode } from '@kinobi-so/node-types';
+import type { DefinedTypeLinkNode, ProgramLinkNode } from '@kinobi-so/node-types';
 
 import { camelCase } from '../shared';
+import { programLinkNode } from './ProgramLinkNode';
 
-export function definedTypeLinkNode(name: string): DefinedTypeLinkNode {
+export function definedTypeLinkNode(name: string, program?: ProgramLinkNode | string): DefinedTypeLinkNode {
     return Object.freeze({
         kind: 'definedTypeLinkNode',
 
+        // Children.
+        ...(program === undefined ? {} : { program: typeof program === 'string' ? programLinkNode(program) : program }),
+
         // Data.
         name: camelCase(name),
     });