docs: adds JSDoc to the npm package '@ory/keto-namespace-types' (#1136)

Co-authored-by: Patrik <zepatrik@users.noreply.github.com>

contrib/namespace-type-lib/index.d.ts

@@ -12,7 +12,41 @@ declare interface IArguments {}
 declare interface RegExp {}
 
 declare interface Array<T extends namespace> {
+  /**
+   * Checks whether the elements of this Array have a Relation to the given Subject
+   * @example
+   * class File implements Namespace {
+   *   related: {
+   *     owners: (User | SubjectSet<Group, "members">)[]
+   *   }
+   *
+   *   permits = {
+   *     edit: (ctx: Context) => this.related.owners.includes(ctx.subject),
+   *   }
+   * }
+   * @param element usually `ctx.subject`
+   */
   includes(element: T): boolean
+
+  /**
+   * Executes the {@link iteratorfn} on every element in the Array and evaluates to true if {@link iteratorfn} returns true for any element.
+   *
+   * @example
+   * class File implements Namespace {
+   *   related: {
+   *     parents: (File | Folder)[]
+   *   }
+   *
+   *   permits = {
+   *     view: (ctx: Context): boolean =>
+   *        // Checks whether the given context (e.g. subject) has view permissions on any of the parents,
+   *        // effectively inhertiting the view permissions of the parents
+   *       this.related.parents.traverse((p) => p.permits.view(ctx))
+   *   }
+   * }
+   *
+   * @param iteratorfn The function that checks if a connection exits
+   */
   traverse(iteratorfn: (element: T) => boolean): boolean
 }
 
@@ -21,7 +55,14 @@ interface context {
 }
 
 interface namespace {
+  /**
+   * Possible Relations to Objects of Namespaces
+   */
   related?: { [relation: string]: namespace[] }
+
+  /**
+   * Dynamically computed Relations
+   */
   permits?: { [method: string]: (ctx: context) => boolean }
 }