declastruct-github 1.0.0 → 1.0.1

package/dist/.test/assets/getSampleRepo.js

@@ -10,10 +10,7 @@ const getSampleRepo = (input) => DeclaredGithubRepo_1.DeclaredGithubRepo.as({
     owner: input.owner,
     name: input.name,
     description: null,
-    homepage: null,
-    private: false,
     visibility: 'public',
-    archived: false,
 });
 exports.getSampleRepo = getSampleRepo;
 //# sourceMappingURL=getSampleRepo.js.map

package/dist/.test/assets/getSampleRepo.js.map

@@ -1 +1 @@
-{"version":3,"file":"getSampleRepo.js","sourceRoot":"","sources":["../../../src/.test/assets/getSampleRepo.ts"],"names":[],"mappings":";;;AAAA,gFAA6E;AAE7E;;;GAGG;AACI,MAAM,aAAa,GAAG,CAAC,KAG7B,EAAsB,EAAE,CACvB,uCAAkB,CAAC,EAAE,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC,KAAK;IAClB,IAAI,EAAE,KAAK,CAAC,IAAI;IAChB,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,QAAQ;IACpB,QAAQ,EAAE,KAAK;CAChB,CAAC,CAAC;AAZQ,QAAA,aAAa,iBAYrB"}
+{"version":3,"file":"getSampleRepo.js","sourceRoot":"","sources":["../../../src/.test/assets/getSampleRepo.ts"],"names":[],"mappings":";;;AAAA,gFAA6E;AAE7E;;;GAGG;AACI,MAAM,aAAa,GAAG,CAAC,KAG7B,EAAsB,EAAE,CACvB,uCAAkB,CAAC,EAAE,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC,KAAK;IAClB,IAAI,EAAE,KAAK,CAAC,IAAI;IAChB,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,QAAQ;CACrB,CAAC,CAAC;AATQ,QAAA,aAAa,iBASrB"}

package/dist/domain.objects/DeclaredGithubBranchProtection.d.ts

@@ -1,4 +1,4 @@
-import { DomainEntity, RefByUnique } from 'domain-objects';
+import { DomainEntity, DomainLiteral, RefByUnique } from 'domain-objects';
 import { DeclaredGithubBranch } from './DeclaredGithubBranch';
 /**
  * .what = a declarative structure which represents GitHub branch protection rules
@@ -104,5 +104,6 @@ export declare class DeclaredGithubBranchProtection extends DomainEntity<Declare
             build<TDobj extends import("domain-objects").Refable<TShape, TPrimary, TUnique>, TShape extends import("domain-objects/dist/reference/Refable").DomainObjectShape = any, TPrimary extends readonly string[] = any, TUnique extends readonly string[] = any>(props: RefByUnique<TDobj, TShape, TPrimary, TUnique>): RefByUnique<TDobj, TShape, TPrimary, TUnique>;
             as<TDobj_1 extends import("domain-objects").Refable<TShape_1, TPrimary_1, TUnique_1>, TShape_1 extends import("domain-objects/dist/reference/Refable").DomainObjectShape = any, TPrimary_1 extends readonly string[] = any, TUnique_1 extends readonly string[] = any>(props: RefByUnique<TDobj_1, TShape_1, TPrimary_1, TUnique_1>): RefByUnique<TDobj_1, TShape_1, TPrimary_1, TUnique_1>;
         };
+        requiredStatusChecks: typeof DomainLiteral;
     };
 }

package/dist/domain.objects/DeclaredGithubBranchProtection.js

@@ -8,5 +8,6 @@ exports.DeclaredGithubBranchProtection = DeclaredGithubBranchProtection;
 DeclaredGithubBranchProtection.unique = ['branch'];
 DeclaredGithubBranchProtection.nested = {
     branch: (domain_objects_1.RefByUnique),
+    requiredStatusChecks: domain_objects_1.DomainLiteral,
 };
 //# sourceMappingURL=DeclaredGithubBranchProtection.js.map

package/dist/domain.objects/DeclaredGithubBranchProtection.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeclaredGithubBranchProtection.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubBranchProtection.ts"],"names":[],"mappings":";;;AAAA,mDAA2D;AAqH3D,MAAa,8BACX,SAAQ,6BAA4C;;AADtD,wEAQC;AAJe,qCAAM,GAAG,CAAC,QAAQ,CAAU,CAAC;AAC7B,qCAAM,GAAG;IACrB,MAAM,EAAE,CAAA,4BAAwC,CAAA;CACjD,CAAC"}
+{"version":3,"file":"DeclaredGithubBranchProtection.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubBranchProtection.ts"],"names":[],"mappings":";;;AAAA,mDAA0E;AAqH1E,MAAa,8BACX,SAAQ,6BAA4C;;AADtD,wEASC;AALe,qCAAM,GAAG,CAAC,QAAQ,CAAU,CAAC;AAC7B,qCAAM,GAAG;IACrB,MAAM,EAAE,CAAA,4BAAwC,CAAA;IAChD,oBAAoB,EAAE,8BAAa;CACpC,CAAC"}

package/dist/domain.objects/DeclaredGithubRepo.d.ts

@@ -35,13 +35,14 @@ export interface DeclaredGithubRepo {
     description: string | null;
     /**
      * .what = homepage URL
-     * .note = null if not set
+     * .note = optional; defaults to null
      */
-    homepage: string | null;
+    homepage?: string | null;
     /**
      * .what = whether the repo is private
+     * .note = optional; derived from visibility !== 'public' if not provided
      */
-    private: boolean;
+    private?: boolean;
     /**
      * .what = visibility setting
      * .note = public, private, or internal (for enterprise)
@@ -49,8 +50,9 @@ export interface DeclaredGithubRepo {
     visibility: 'public' | 'private' | 'internal';
     /**
      * .what = whether the repo is archived
+     * .note = optional; defaults to false
      */
-    archived: boolean;
+    archived?: boolean;
 }
 export declare class DeclaredGithubRepo extends DomainEntity<DeclaredGithubRepo> implements DeclaredGithubRepo {
     static unique: readonly ["owner", "name"];

package/dist/domain.objects/DeclaredGithubRepo.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeclaredGithubRepo.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubRepo.ts"],"names":[],"mappings":";;;AACA,mDAA8C;AAgE9C,MAAa,kBACX,SAAQ,6BAAgC;;AAD1C,gDAKC;AADe,yBAAM,GAAG,CAAC,OAAO,EAAE,MAAM,CAAU,CAAC"}
+{"version":3,"file":"DeclaredGithubRepo.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubRepo.ts"],"names":[],"mappings":";;;AACA,mDAA8C;AAkE9C,MAAa,kBACX,SAAQ,6BAAgC;;AAD1C,gDAKC;AADe,yBAAM,GAAG,CAAC,OAAO,EAAE,MAAM,CAAU,CAAC"}

package/dist/domain.operations/repo/castToDeclaredGithubRepo.js

@@ -25,14 +25,15 @@ const getOrThrow = (obj, key) => {
  * .why = transforms external API shape to our domain model with type safety and validation
  */
 const castToDeclaredGithubRepo = (input) => {
+    const visibility = input.visibility ?? 'public';
     return DeclaredGithubRepo_1.DeclaredGithubRepo.as({
         id: getOrThrow(input, 'id'),
         owner: getOrThrow(getOrThrow(input, 'owner'), 'login'),
         name: getOrThrow(input, 'name'),
         description: input.description ?? null,
         homepage: input.homepage ?? null,
-        private: getOrThrow(input, 'private'),
-        visibility: input.visibility ?? 'public',
+        private: input.private ?? visibility !== 'public',
+        visibility,
         archived: input.archived ?? false,
         createdAt: input.created_at ? (0, uni_time_1.asUniDateTime)(input.created_at) : undefined,
         updatedAt: input.updated_at ? (0, uni_time_1.asUniDateTime)(input.updated_at) : undefined,

package/dist/domain.operations/repo/castToDeclaredGithubRepo.js.map

@@ -1 +1 @@
-{"version":3,"file":"castToDeclaredGithubRepo.js","sourceRoot":"","sources":["../../../src/domain.operations/repo/castToDeclaredGithubRepo.ts"],"names":[],"mappings":";;;AAAA,iDAAmD;AAEnD,mDAAyD;AACzD,uCAAqE;AAErE,gFAA6E;AAE7E;;;GAGG;AACH,MAAM,UAAU,GAAG,CACjB,GAAM,EACN,GAAM,EACc,EAAE;IACtB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IAEvB,kCAAkC;IAClC,IAAI,IAAA,yBAAc,EAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,uBAAuB;IACvB,wCAAuB,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;QACpE,KAAK,EAAE,GAAG;QACV,GAAG;KACJ,CAAC,CAAC;AACL,CAAC,CAAC;AAOF;;;GAGG;AACI,MAAM,wBAAwB,GAAG,CACtC,KAAyB,EACQ,EAAE;IACnC,OAAO,uCAAkB,CAAC,EAAE,CAAC;QAC3B,EAAE,EAAE,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;QAC3B,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QACtD,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;QAC/B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;QACtC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;QAChC,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;QACrC,UAAU,EACP,KAAK,CAAC,UAAgD,IAAI,QAAQ;QACrE,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK;QACjC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;QACzE,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;KAC1E,CAAoC,CAAC;AACxC,CAAC,CAAC;AAhBW,QAAA,wBAAwB,4BAgBnC"}
+{"version":3,"file":"castToDeclaredGithubRepo.js","sourceRoot":"","sources":["../../../src/domain.operations/repo/castToDeclaredGithubRepo.ts"],"names":[],"mappings":";;;AAAA,iDAAmD;AAEnD,mDAAyD;AACzD,uCAAqE;AAErE,gFAA6E;AAE7E;;;GAGG;AACH,MAAM,UAAU,GAAG,CACjB,GAAM,EACN,GAAM,EACc,EAAE;IACtB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IAEvB,kCAAkC;IAClC,IAAI,IAAA,yBAAc,EAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,uBAAuB;IACvB,wCAAuB,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;QACpE,KAAK,EAAE,GAAG;QACV,GAAG;KACJ,CAAC,CAAC;AACL,CAAC,CAAC;AAOF;;;GAGG;AACI,MAAM,wBAAwB,GAAG,CACtC,KAAyB,EACQ,EAAE;IACnC,MAAM,UAAU,GACb,KAAK,CAAC,UAAgD,IAAI,QAAQ,CAAC;IAEtE,OAAO,uCAAkB,CAAC,EAAE,CAAC;QAC3B,EAAE,EAAE,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;QAC3B,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QACtD,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;QAC/B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;QACtC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;QAChC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,UAAU,KAAK,QAAQ;QACjD,UAAU;QACV,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK;QACjC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;QACzE,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;KAC1E,CAAoC,CAAC;AACxC,CAAC,CAAC;AAlBW,QAAA,wBAAwB,4BAkBnC"}

package/dist/domain.operations/repo/setRepo.js

@@ -12,6 +12,10 @@ const getRepo_1 = require("./getRepo");
  */
 exports.setRepo = (0, as_procedure_1.asProcedure)(async (input, context) => {
     const desired = input.finsert ?? input.upsert;
+    // apply defaults for optional fields
+    const desiredHomepage = desired.homepage ?? null;
+    const desiredPrivate = desired.private ?? desired.visibility !== 'public';
+    const desiredArchived = desired.archived ?? false;
     // get cached GitHub client
     const github = (0, getGithubClient_1.getGithubClient)({}, context);
     // check whether it already exists
@@ -33,10 +37,10 @@ exports.setRepo = (0, as_procedure_1.asProcedure)(async (input, context) => {
                 owner: desired.owner,
                 repo: desired.name,
                 description: desired.description ?? undefined,
-                homepage: desired.homepage ?? undefined,
-                private: desired.private,
+                homepage: desiredHomepage ?? undefined,
+                private: desiredPrivate,
                 visibility: desired.visibility === 'internal' ? undefined : desired.visibility,
-                archived: desired.archived,
+                archived: desiredArchived,
             });
             return (0, castToDeclaredGithubRepo_1.castToDeclaredGithubRepo)(updated.data);
         }
@@ -55,8 +59,8 @@ exports.setRepo = (0, as_procedure_1.asProcedure)(async (input, context) => {
             org: desired.owner,
             name: desired.name,
             description: desired.description ?? undefined,
-            homepage: desired.homepage ?? undefined,
-            private: desired.private,
+            homepage: desiredHomepage ?? undefined,
+            private: desiredPrivate,
             visibility: desired.visibility === 'internal' ? undefined : desired.visibility,
         });
         return (0, castToDeclaredGithubRepo_1.castToDeclaredGithubRepo)(created.data);

package/dist/domain.operations/repo/setRepo.js.map

@@ -1 +1 @@
-{"version":3,"file":"setRepo.js","sourceRoot":"","sources":["../../../src/domain.operations/repo/setRepo.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,mDAA8C;AAI9C,uEAAoE;AAGpE,yEAAsE;AACtE,uCAAoC;AAEpC;;;GAGG;AACU,QAAA,OAAO,GAAG,IAAA,0BAAW,EAChC,KAAK,EACH,KAGE,EACF,OAA6C,EACH,EAAE;IAC5C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC;IAE9C,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE5C,kCAAkC;IAClC,MAAM,MAAM,GAAG,MAAM,IAAA,iBAAO,EAC1B;QACE,EAAE,EAAE;YACF,MAAM,EAAE;gBACN,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB;SACF;KACF,EACD,OAAO,CACR,CAAC;IAEF,uDAAuD;IACvD,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC;IAE3C,4EAA4E;IAC5E,IAAI,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;gBACxC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,SAAS;gBAC7C,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,SAAS;gBACvC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,UAAU,EACR,OAAO,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpE,QAAQ,EAAE,OAAO,CAAC,QAAQ;aAC3B,CAAC,CAAC;YAEH,OAAO,IAAA,mDAAwB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;gBAAE,MAAM,KAAK,CAAC;YAC3C,MAAM,IAAI,6BAAY,CAAC,6BAA6B,EAAE;gBACpD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,uBAAuB;IACvB,IAAI,CAAC;QACH,kEAAkE;QAClE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC7C,GAAG,EAAE,OAAO,CAAC,KAAK;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,SAAS;YAC7C,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,SAAS;YACvC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EACR,OAAO,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU;SACrE,CAAC,CAAC;QAEH,OAAO,IAAA,mDAAwB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC;QAC3C,MAAM,IAAI,6BAAY,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC,CACF,CAAC"}
+{"version":3,"file":"setRepo.js","sourceRoot":"","sources":["../../../src/domain.operations/repo/setRepo.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,mDAA8C;AAI9C,uEAAoE;AAGpE,yEAAsE;AACtE,uCAAoC;AAEpC;;;GAGG;AACU,QAAA,OAAO,GAAG,IAAA,0BAAW,EAChC,KAAK,EACH,KAGE,EACF,OAA6C,EACH,EAAE;IAC5C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC;IAE9C,qCAAqC;IACrC,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;IACjD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC1E,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;IAElD,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE5C,kCAAkC;IAClC,MAAM,MAAM,GAAG,MAAM,IAAA,iBAAO,EAC1B;QACE,EAAE,EAAE;YACF,MAAM,EAAE;gBACN,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB;SACF;KACF,EACD,OAAO,CACR,CAAC;IAEF,uDAAuD;IACvD,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC;IAE3C,4EAA4E;IAC5E,IAAI,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;gBACxC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,SAAS;gBAC7C,QAAQ,EAAE,eAAe,IAAI,SAAS;gBACtC,OAAO,EAAE,cAAc;gBACvB,UAAU,EACR,OAAO,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpE,QAAQ,EAAE,eAAe;aAC1B,CAAC,CAAC;YAEH,OAAO,IAAA,mDAAwB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;gBAAE,MAAM,KAAK,CAAC;YAC3C,MAAM,IAAI,6BAAY,CAAC,6BAA6B,EAAE;gBACpD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,uBAAuB;IACvB,IAAI,CAAC;QACH,kEAAkE;QAClE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC7C,GAAG,EAAE,OAAO,CAAC,KAAK;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,SAAS;YAC7C,QAAQ,EAAE,eAAe,IAAI,SAAS;YACtC,OAAO,EAAE,cAAc;YACvB,UAAU,EACR,OAAO,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU;SACrE,CAAC,CAAC;QAEH,OAAO,IAAA,mDAAwB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC;QAC3C,MAAM,IAAI,6BAAY,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC,CACF,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "declastruct-github",
   "author": "ehmpathy",
   "description": "declarative control of GitHub constructs via declastruct - manage repos, branches, and protection rules",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "repository": "ehmpathy/declastruct-github",
   "homepage": "https://github.com/ehmpathy/declastruct-github",
   "keywords": [
@@ -55,8 +55,7 @@
     "@ehmpathy/uni-time": "1.7.4",
     "@octokit/rest": "^21.0.0",
     "as-procedure": "1.1.1",
-    "declastruct": "1.1.5",
-    "domain-objects": "0.29.1",
+    "domain-objects": "0.29.2",
     "helpful-errors": "1.5.3",
     "simple-in-memory-cache": "0.4.0",
     "type-fns": "1.19.0",
@@ -79,6 +78,7 @@
     "cz-conventional-changelog": "3.3.0",
     "declapract": "0.12.0",
     "declapract-typescript-ehmpathy": "0.39.5",
+    "declastruct": "1.1.7",
     "depcheck": "1.4.3",
     "eslint": "8.56.0",
     "eslint-config-airbnb-typescript": "18.0.0",

package/readme.md

@@ -23,39 +23,59 @@ npm install -s declastruct-github
 declare the resources you wish to have - and what state you wish them to be in
 
 ```ts
+import { UnexpectedCodePathError } from 'helpful-errors';
 import { getDeclastructGithubProvider, DeclaredGithubRepo, DeclaredGithubRepoConfig } from 'declastruct-github';
 
-export const getProviders = async () => [
-  getDeclastructGithubProvider({
-    credentials: {
-      token: process.env.GITHUB_TOKEN,
-    }
-  })
-]
-
-export const getResources = async () => {
+export const getProviders = async (): Promise<DeclastructProvider[]> => [
+  getDeclastructGithubProvider(
+    {
+      credentials: {
+        token:
+          process.env.GITHUB_TOKEN ??
+          UnexpectedCodePathError.throw('github token not supplied'),
+      },
+    },
+    {
+      log: console,
+    },
+  ),
+];
+
+export const getResources = async (): Promise<DomainEntity<any>[]> => {
+  // declare the repo
   const repo = DeclaredGithubRepo.as({
-    name: 'super repo',
+    owner: 'ehmpathy',
+    name: 'declastruct-github',
+    description: 'declarative control of Github resource constructs, via declastruct',
+    visibility: 'public',
   });
+
+  // declare config for the repo
   const repoConfig = DeclaredGithubRepoConfig.as({
-    repo: refByUnique(repo),
+    repo,
+
+    // explicitly set the main branch
+    defaultBranch: 'main',
+
+    // we only use issues; the rest is noise today
+    hasIssues: true,
+    hasProjects: false,
+    hasWiki: false,
+    hasDownloads: false,
+    isTemplate: false,
 
-    // for example, only allow squash merges
+    // only squash merges are allowed
     allowSquashMerge: true,
-    allowMergeCommit: false,
+    allowMergeCommit: false, // but especially not merge merges. never merge merges
     allowRebaseMerge: false,
 
-    // ... see the docs or types for other options
+    // always cleanup after yourself
+    deleteBranchOnMerge: true,
   });
 
-  // ... add whatever resources you wish
-
-  return [
-    repo,
-    repoConfig,
-    // ... all the resources you wish for will go here
-  ],
-}
+  // and return the full set
+  return [repo, repoConfig];
+};
 ```
 
 ### plan 🔮
@@ -82,22 +102,47 @@ npx declastruct apply --plan provision/github/.temp/plan.json
 ## example.2
 
 ```ts
-export const getResources = async () => {
+export const getProviders = async (): Promise<DeclastructProvider[]> => [
+  getDeclastructGithubProvider(
+    {
+      credentials: {
+        token:
+          process.env.GITHUB_TOKEN ??
+          UnexpectedCodePathError.throw('github token not supplied'),
+      },
+    },
+    {
+      log: {
+        info: () => {},
+        debug: () => {},
+        warn: console.warn,
+        error: console.error,
+      },
+    },
+  ),
+];
+
+export const getResources = async (): Promise<DomainEntity<any>[]> => {
   // declare the repo
   const repo = DeclaredGithubRepo.as({
-    name: "your repo",
+    owner: 'ehmpathy',
+    name: 'declastruct-github',
+    description: 'declarative control of Github resource constructs, via declastruct',
+    visibility: 'public',
   });
 
-  // declare the main branch
-  const branchMain = DeclaredGithubBranch.as({
-    repo: refByUnique(repo),
+  // ref the main branch
+  const branchMain = RefByUnique.as<typeof DeclaredGithubBranch>({
     name: 'main',
-  })
+    repo,
+  });
 
   // declare config for the repo
   const repoConfig = DeclaredGithubRepoConfig.as({
+    repo,
+
     // explicitly set the main branch
-    defaultBranch: refByUnique(branchMain),
+    defaultBranch: branchMain.name,
 
     // we only use issues; the rest is noise today
     hasIssues: true,
@@ -117,37 +162,32 @@ export const getResources = async () => {
 
   // declare protection for that branch, too
   const branchMainProtection = DeclaredGithubBranchProtection.as({
-    branch: refByUnique(branchMain),
+    branch: branchMain,
 
     enforceAdmins: true, // yes, even admins need to follow this (note: they can still take the time to go and change the settings temporarily for the exceptions)
     allowsDeletions: false, // dont allow the `main` branch to be deleted
     allowsForcePushes: false, // dont allow `main` branch to be force pushed to
     requireLinearHistory: false, //  # no ugly merge commits, woo! 🎉
 
-    requiedStatusChecks: {
+    requiredStatusChecks: {
       strict: true, // branch must be up to date. otherwise, we dont know if it will really pass once it is merged
-      contexts = [
-        "suite / install / npm",
-        "suite / test-commits",
-        "suite / test-types",
-        "suite / test-format",
-        "suite / test-lint",
-        "suite / test-unit",
-        "suite / test-integration",
-        "suite / test-acceptance-locally",
-        "pullreq-title" // "review / pullreq-title",
-      ]
-    }
-  })
-
-
-  return [
-    repo,
-    branchMain,
-    repoConfig,
-    branchMainProtection,
-  ]
-}
+      contexts: [
+        'suite / install / npm',
+        'suite / test-commits',
+        'suite / test-types',
+        'suite / test-format',
+        'suite / test-lint',
+        'suite / test-unit',
+        'suite / test-integration',
+        'suite / test-acceptance-locally',
+        'pullreq-title', // "review / pullreq-title",
+      ],
+    },
+  });
+
+  // and return the full set
+  return [repo, branchMain, repoConfig, branchMainProtection];
+};
 ```
 
 # use imperatively