@leofcoin/standards 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @leofcoin/standards
 
-## Unreleased
+## 0.3.0
 
 ### Changed
 
@@ -9,7 +9,7 @@
 
 ### Added
 
-- GitHub Actions workflow for automated testing across Node.js versions 18.x, 20.x, 22.x
+- GitHub Actions workflow for automated testing across Node.js versions 22.x and latest
 - Test status badge in README
 - Comprehensive unit tests for helpers, roles, token, and voting modules
 - Meta base class for state management

package/exports/index.d.ts

@@ -4,4 +4,5 @@ export { default as Token } from './token.js';
 export { default as TokenReceiver } from './token-receiver.js';
 export { default as PublicVoting } from './voting/public-voting.js';
 export { default as PrivateVoting } from './voting/private-voting.js';
+export type * from './interfaces.js';
 export * from './helpers.js';

package/exports/interfaces.d.ts

@@ -0,0 +1,47 @@
+export interface MetaState {
+    creator: address;
+    createdAt: bigint;
+}
+export declare interface RolesState extends MetaState {
+    roles: {
+        [index: string]: address[];
+    };
+}
+export declare interface TokenState extends RolesState {
+    holders: bigint;
+    balances: {
+        [address: address]: bigint;
+    };
+    approvals: {
+        [owner: address]: {
+            [operator: address]: bigint;
+        };
+    };
+    totalSupply: bigint;
+}
+export interface VotingState extends MetaState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+export interface PrivateVotingState extends VotingState {
+    voters: address[];
+}
+export type VoteResult = 0 | 0.5 | 1;
+export type Vote = {
+    title: string;
+    method: string;
+    args: any[];
+    description: string;
+    endTime: EpochTimeStamp;
+    results?: {
+        [address: string]: VoteResult;
+    };
+    finished?: boolean;
+    enoughVotes?: boolean;
+};
+export interface VoteView extends Vote {
+    id: string;
+}

package/exports/interfaces.js

@@ -0,0 +1 @@
+

package/exports/meta.d.ts

@@ -1,4 +1,4 @@
-import { MetaState } from './types.js';
+import { MetaState } from './interfaces.js';
 export default class Meta {
     #private;
     constructor(state?: MetaState);

package/exports/roles.d.ts

@@ -1,5 +1,5 @@
 import Meta from './meta.js';
-import { RolesState } from './types.js';
+import { RolesState } from './interfaces.js';
 export default class Roles extends Meta {
     #private;
     constructor(state?: RolesState);

package/exports/token-receiver.d.ts

@@ -1,6 +1,6 @@
 import { IPublicVoting } from './voting/interfaces/i-public-voting.js';
 import PublicVoting from './voting/public-voting.js';
-import { VotingState } from './voting/types.js';
+import { VotingState } from './interfaces.js';
 export interface TokenReceiverState extends VotingState {
     tokenToReceive: address;
     tokenReceiver: address;
@@ -19,7 +19,7 @@ export default class TokenReceiver extends PublicVoting implements IPublicVoting
         tokenAmountToReceive: bigint;
         voteType: "burn" | "transfer";
         votes: {
-            [id: string]: import("./voting/types.js").Vote;
+            [id: string]: import("./interfaces.js").Vote;
         };
         votingDisabled: boolean;
         votingDuration: number;

package/exports/token.d.ts

@@ -1,5 +1,5 @@
 import Roles from './roles.js';
-import { TokenState } from './types.js';
+import { TokenState } from './interfaces.js';
 export default class Token extends Roles {
     #private;
     constructor(name: string, symbol: string, decimals?: number, state?: TokenState);

package/exports/types.d.ts

@@ -19,3 +19,29 @@ export declare interface TokenState extends RolesState {
     };
     totalSupply: bigint;
 }
+export interface VotingState extends MetaState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+export interface PrivateVotingState extends VotingState {
+    voters: address[];
+}
+export type VoteResult = 0 | 0.5 | 1;
+export type Vote = {
+    title: string;
+    method: string;
+    args: any[];
+    description: string;
+    endTime: EpochTimeStamp;
+    results?: {
+        [address: string]: VoteResult;
+    };
+    finished?: boolean;
+    enoughVotes?: boolean;
+};
+export interface VoteView extends Vote {
+    id: string;
+}

package/exports/types.js

@@ -0,0 +1 @@
+

package/exports/voting/private-voting.d.ts

@@ -1,16 +1,17 @@
 import Meta from '../meta.js';
-import { PrivateVotingState, VoteResult, VoteView } from './types.js';
+import { PrivateVotingState, VoteResult, VoteView } from '../interfaces.js';
 export default class PrivateVoting extends Meta {
     #private;
     constructor(state: PrivateVotingState);
     get votes(): {
-        [x: string]: import("./types.js").Vote;
+        [id: string]: import("../interfaces.js").Vote;
     };
     get voters(): {
-        [x: number]: string;
+        [n: number]: string;
         length: number;
         toString(): string;
         toLocaleString(): string;
+        toLocaleString(locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string;
         pop(): string;
         push(...items: string[]): number;
         concat(...items: ConcatArray<string>[]): string[];
@@ -30,27 +31,27 @@ export default class PrivateVoting extends Meta {
         some(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
         forEach(callbackfn: (value: string, index: number, array: string[]) => void, thisArg?: any): void;
         map<U>(callbackfn: (value: string, index: number, array: string[]) => U, thisArg?: any): U[];
-        filter<S_1 extends string>(predicate: (value: string, index: number, array: string[]) => value is S_1, thisArg?: any): S_1[];
+        filter<S extends string>(predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): S[];
         filter(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[];
         reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
         reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduce<U_1>(callbackfn: (previousValue: U_1, currentValue: string, currentIndex: number, array: string[]) => U_1, initialValue: U_1): U_1;
+        reduce<U>(callbackfn: (previousValue: U, currentValue: string, currentIndex: number, array: string[]) => U, initialValue: U): U;
         reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
         reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduceRight<U_2>(callbackfn: (previousValue: U_2, currentValue: string, currentIndex: number, array: string[]) => U_2, initialValue: U_2): U_2;
-        find<S_2 extends string>(predicate: (value: string, index: number, obj: string[]) => value is S_2, thisArg?: any): S_2;
+        reduceRight<U>(callbackfn: (previousValue: U, currentValue: string, currentIndex: number, array: string[]) => U, initialValue: U): U;
+        find<S extends string>(predicate: (value: string, index: number, obj: string[]) => value is S, thisArg?: any): S;
         find(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string;
         findIndex(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): number;
         fill(value: string, start?: number, end?: number): string[];
         copyWithin(target: number, start: number, end?: number): string[];
-        entries(): IterableIterator<[number, string]>;
-        keys(): IterableIterator<number>;
-        values(): IterableIterator<string>;
+        entries(): ArrayIterator<[number, string]>;
+        keys(): ArrayIterator<number>;
+        values(): ArrayIterator<string>;
         includes(searchElement: string, fromIndex?: number): boolean;
-        flatMap<U_3, This = undefined>(callback: (this: This, value: string, index: number, array: string[]) => U_3 | readonly U_3[], thisArg?: This): U_3[];
+        flatMap<U, This = undefined>(callback: (this: This, value: string, index: number, array: string[]) => U | readonly U[], thisArg?: This): U[];
         flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
         at(index: number): string;
-        [Symbol.iterator](): IterableIterator<string>;
+        [Symbol.iterator](): ArrayIterator<string>;
         [Symbol.unscopables]: {
             [x: number]: boolean;
             length?: boolean;

package/exports/voting/public-voting.d.ts

@@ -1,5 +1,5 @@
 import Meta from '../meta.js';
-import { VotingState, VoteResult } from './types.js';
+import { VotingState, VoteResult } from '../interfaces.js';
 /**
  * allows everybody that has a balance greater or equal to tokenAmountToReceive to vote
  */
@@ -7,7 +7,7 @@ export default class PublicVoting extends Meta {
     #private;
     constructor(state: VotingState);
     get votes(): {
-        [x: string]: import("./types.js").Vote;
+        [id: string]: import("../interfaces.js").Vote;
     };
     get votingDuration(): number;
     get votingDisabled(): boolean;
@@ -16,7 +16,7 @@ export default class PublicVoting extends Meta {
      */
     get state(): {
         votes: {
-            [id: string]: import("./types.js").Vote;
+            [id: string]: import("../interfaces.js").Vote;
         };
         votingDisabled: boolean;
         votingDuration: number;
@@ -27,7 +27,7 @@ export default class PublicVoting extends Meta {
         method: string;
         args: any[];
         description: string;
-        endTime: number;
+        endTime: EpochTimeStamp;
         results?: {
             [address: string]: VoteResult;
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leofcoin/standards",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Contract standards",
   "type": "module",
   "exports": {
@@ -8,40 +8,98 @@
       "import": "./exports/index.js",
       "types": "./exports/index.d.ts"
     },
-    "./token": {
-      "import": "./exports/token.js",
-      "types": "./exports/token.d.ts"
+    "./helpers": {
+      "import": "./exports/helpers.js",
+      "types": "./exports/helpers.d.ts"
     },
-    "./roles": {
-      "import": "./exports/roles.js",
-      "types": "./exports/roles.d.ts"
+    "./helpers.js": {
+      "import": "./exports/helpers.js",
+      "types": "./exports/helpers.d.ts"
     },
-    "./public-voting": {
-      "import": "./exports/public-voting.js",
-      "types": "./exports/public-voting.d.ts"
+    "./i-public-voting": {
+      "import": "./exports/i-public-voting.js",
+      "types": "./exports/voting/interfaces/i-public-voting.d.ts"
+    },
+    "./i-public-voting.js": {
+      "import": "./exports/i-public-voting.js",
+      "types": "./exports/voting/interfaces/i-public-voting.d.ts"
+    },
+    "./index.js": {
+      "import": "./exports/index.js",
+      "types": "./exports/index.d.ts"
+    },
+    "./interfaces": {
+      "import": "./exports/interfaces.js",
+      "types": "./exports/interfaces.d.ts"
+    },
+    "./interfaces.js": {
+      "import": "./exports/interfaces.js",
+      "types": "./exports/interfaces.d.ts"
+    },
+    "./meta": {
+      "import": "./exports/meta.js",
+      "types": "./exports/meta.d.ts"
+    },
+    "./meta.js": {
+      "import": "./exports/meta.js",
+      "types": "./exports/meta.d.ts"
     },
     "./private-voting": {
       "import": "./exports/private-voting.js",
-      "types": "./exports/private-voting.d.ts"
+      "types": "./exports/voting/private-voting.d.ts"
+    },
+    "./private-voting.js": {
+      "import": "./exports/private-voting.js",
+      "types": "./exports/voting/private-voting.d.ts"
+    },
+    "./public-voting": {
+      "import": "./exports/public-voting.js",
+      "types": "./exports/voting/interfaces/public-voting.d.ts"
+    },
+    "./public-voting.js": {
+      "import": "./exports/public-voting.js",
+      "types": "./exports/voting/interfaces/public-voting.d.ts"
+    },
+    "./roles": {
+      "import": "./exports/roles.js",
+      "types": "./exports/roles.d.ts"
+    },
+    "./roles.js": {
+      "import": "./exports/roles.js",
+      "types": "./exports/roles.d.ts"
     },
     "./token-receiver": {
       "import": "./exports/token-receiver.js",
       "types": "./exports/token-receiver.d.ts"
     },
-    "./interfaces/i-public-voting": {
-      "import": "./exports/i-public-voting.js",
-      "types": "./exports/i-public-voting.d.ts"
+    "./token-receiver.js": {
+      "import": "./exports/token-receiver.js",
+      "types": "./exports/token-receiver.d.ts"
     },
-    "./helpers": {
-      "import": "./exports/helpers.js",
-      "types": "./exports/helpers.d.ts"
+    "./token": {
+      "import": "./exports/token.js",
+      "types": "./exports/token.d.ts"
+    },
+    "./token.js": {
+      "import": "./exports/token.js",
+      "types": "./exports/token.d.ts"
+    },
+    "./types": {
+      "import": "./exports/types.js",
+      "types": "./exports/voting/types.d.ts"
+    },
+    "./types.js": {
+      "import": "./exports/types.js",
+      "types": "./exports/voting/types.d.ts"
+    },
+    "./voting": {
+      "import": "./exports/voting.js",
+      "types": "./exports/voting.d.ts"
     },
-    "./token.js": "./exports/token.js",
-    "./roles.js": "./exports/roles.js",
-    "./public-voting.js": "./exports/public-voting.js",
-    "./interfaces/i-public-voting.js": "./exports/i-public-voting.js",
-    "./private-voting.js": "./exports/private-voting.js",
-    "./helpers.js": "./exports/helpers.js"
+    "./voting.js": {
+      "import": "./exports/voting.js",
+      "types": "./exports/voting.d.ts"
+    }
   },
   "scripts": {
     "build": "rollup -c",
@@ -62,6 +120,7 @@
     "@leofcoin/global-types": "^1.0.2",
     "@rollup/plugin-typescript": "^12.3.0",
     "rollup": "^4.54.0",
+    "rollup-plugin-auto-exports": "^1.1.1",
     "tslib": "^2.8.1"
   }
 }

package/rollup.config.js

@@ -1,5 +1,6 @@
 import typescript from '@rollup/plugin-typescript'
 import { execSync } from 'child_process'
+import autoExports from 'rollup-plugin-auto-exports'
 
 // const templates = (await readdir('./src/templates')).map(path => join('./src/templates', path))
 const clean = () => {
@@ -17,12 +18,24 @@ export default [
       'src/voting/interfaces/i-public-voting.ts',
       'src/voting/private-voting.ts',
       'src/helpers.ts',
-      'src/token-receiver.ts'
+      'src/token-receiver.ts',
+      'src/interfaces.ts'
     ],
     output: {
       dir: './exports',
       format: 'es'
     },
-    plugins: [typescript()]
+    plugins: [
+      typescript(),
+      autoExports({
+        exportsDir: 'exports',
+        defaultExports: {
+          '.': {
+            import: 'exports/index.js',
+            types: 'exports/index.d.ts'
+          }
+        }
+      })
+    ]
   }
 ]

package/src/index.ts

@@ -4,5 +4,5 @@ export { default as Token } from './token.js'
 export { default as TokenReceiver } from './token-receiver.js'
 export { default as PublicVoting } from './voting/public-voting.js'
 export { default as PrivateVoting } from './voting/private-voting.js'
-
+export type * from './interfaces.js'
 export * from './helpers.js'

package/src/{voting/types.ts → interfaces.ts}

@@ -1,4 +1,18 @@
-import { MetaState } from '../types.js'
+export interface MetaState {
+  creator: address
+  createdAt: bigint
+}
+
+export declare interface RolesState extends MetaState {
+  roles: { [index: string]: address[] }
+}
+
+export declare interface TokenState extends RolesState {
+  holders: bigint
+  balances: { [address: address]: bigint }
+  approvals: { [owner: address]: { [operator: address]: bigint } }
+  totalSupply: bigint
+}
 
 export interface VotingState extends MetaState {
   votes: {

package/src/meta.ts

@@ -1,4 +1,4 @@
-import { MetaState } from './types.js'
+import { MetaState } from './interfaces.js'
 
 export default class Meta {
   #creator: address

package/src/roles.ts

@@ -1,5 +1,5 @@
 import Meta from './meta.js'
-import { RolesState } from './types.js'
+import { RolesState } from './interfaces.js'
 
 export default class Roles extends Meta {
   /**

package/src/token-receiver.ts

@@ -1,6 +1,6 @@
 import { IPublicVoting } from './voting/interfaces/i-public-voting.js'
 import PublicVoting from './voting/public-voting.js'
-import { VotingState } from './voting/types.js'
+import { VotingState } from './interfaces.js'
 
 export interface TokenReceiverState extends VotingState {
   tokenToReceive: address

package/src/token.ts

@@ -1,6 +1,6 @@
 import { restoreApprovals, restoreBalances } from './helpers.js'
 import Roles from './roles.js'
-import { TokenState } from './types.js'
+import { TokenState } from './interfaces.js'
 
 export default class Token extends Roles {
   /**

package/src/voting/private-voting.ts

@@ -4,7 +4,7 @@ import {
   VoteResult,
   VoteView,
   VotingState
-} from './types.js'
+} from '../interfaces.js'
 
 export default class PrivateVoting extends Meta {
   #voters: PrivateVotingState['voters']

package/src/voting/public-voting.ts

@@ -1,5 +1,5 @@
 import Meta from '../meta.js'
-import { VotingState, VoteResult } from './types.js'
+import { VotingState, VoteResult } from '../interfaces.js'
 
 /**
  * allows everybody that has a balance greater or equal to tokenAmountToReceive to vote

package/src/types.ts

@@ -1,15 +0,0 @@
-export interface MetaState {
-  creator: address
-  createdAt: bigint
-}
-
-export declare interface RolesState extends MetaState {
-  roles: { [index: string]: address[] }
-}
-
-export declare interface TokenState extends RolesState {
-  holders: bigint
-  balances: { [address: address]: bigint }
-  approvals: { [owner: address]: { [operator: address]: bigint } }
-  totalSupply: bigint
-}