@hedia/types 2.1.49-alpha.0 → 2.1.49-alpha.1

package/.github/workflows/ci.yaml

@@ -0,0 +1,38 @@
+name: Node.js CI
+
+on:
+  pull_request:
+
+env:
+  SSH_PRIVATE_KEY: ${{ secrets.HEDIA_BOT_PRIVATE_SSH_KEY }}
+  NPM_TOKEN: ${{ secrets.HEDIA_BOT_NPM_TOKEN }}
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.15] #[8.x, 10.x, 12.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1.4.4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Register ssh keys
+        uses: webfactory/ssh-agent@v0.4.1
+        with:
+          ssh-private-key: |
+            ${{ env.SSH_PRIVATE_KEY }}
+      - name: Register NPM access token
+        run: npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
+        env:
+          NPM_TOKEN: ${{ env.NPM_TOKEN }}
+
+      - run: npm ci --ignore-scripts
+      - run: npm run prettier
+      - run: npm run lint
+      - run: npm run tsc

package/dist/types/activity/activity.js.map

@@ -1 +1 @@
-{"version":3,"file":"activity.js","sourceRoot":"","sources":["../../../types/activity/activity.ts"],"names":[],"mappings":";;;AAAA,IAAiB,QAAQ,CAyExB;AAzED,WAAiB,QAAQ;IAiDxB,IAAiB,KAAK,CAuBrB;IAvBD,WAAiB,KAAK;QACrB,sHAAsH;QACtH,IAAY,0BAIX;QAJD,WAAY,0BAA0B;YACrC,mDAAqB,CAAA;YACrB,uDAAyB,CAAA;YACzB,2DAA6B,CAAA;QAC9B,CAAC,EAJW,0BAA0B,GAA1B,gCAA0B,KAA1B,gCAA0B,QAIrC;QAED,8EAA8E;QAC9E,IAAY,iBAIX;QAJD,WAAY,iBAAiB;YAC5B,oCAAe,CAAA;YACf,0CAAqB,CAAA;YACrB,kCAAa,CAAA;QACd,CAAC,EAJW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAI5B;QAED,iFAAiF;QACjF,IAAY,YAMX;QAND,WAAY,YAAY;YACvB,2BAAW,CAAA;YACX,6BAAa,CAAA;YACb,mCAAmB,CAAA;YACnB,6BAAa,CAAA;YACb,+BAAe,CAAA;QAChB,CAAC,EANW,YAAY,GAAZ,kBAAY,KAAZ,kBAAY,QAMvB;IACF,CAAC,EAvBgB,KAAK,GAAL,cAAK,KAAL,cAAK,QAuBrB;AACF,CAAC,EAzEgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAyExB"}
+{"version":3,"file":"activity.js","sourceRoot":"","sources":["../../../types/activity/activity.ts"],"names":[],"mappings":";;;AAAA,IAAiB,QAAQ,CA2ExB;AA3ED,WAAiB,QAAQ;IAmDxB,IAAiB,KAAK,CAuBrB;IAvBD,WAAiB,KAAK;QACrB,sHAAsH;QACtH,IAAY,0BAIX;QAJD,WAAY,0BAA0B;YACrC,mDAAqB,CAAA;YACrB,uDAAyB,CAAA;YACzB,2DAA6B,CAAA;QAC9B,CAAC,EAJW,0BAA0B,GAA1B,gCAA0B,KAA1B,gCAA0B,QAIrC;QAED,8EAA8E;QAC9E,IAAY,iBAIX;QAJD,WAAY,iBAAiB;YAC5B,oCAAe,CAAA;YACf,0CAAqB,CAAA;YACrB,kCAAa,CAAA;QACd,CAAC,EAJW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAI5B;QAED,iFAAiF;QACjF,IAAY,YAMX;QAND,WAAY,YAAY;YACvB,2BAAW,CAAA;YACX,6BAAa,CAAA;YACb,mCAAmB,CAAA;YACnB,6BAAa,CAAA;YACb,+BAAe,CAAA;QAChB,CAAC,EANW,YAAY,GAAZ,kBAAY,KAAZ,kBAAY,QAMvB;IACF,CAAC,EAvBgB,KAAK,GAAL,cAAK,KAAL,cAAK,QAuBrB;AACF,CAAC,EA3EgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA2ExB"}

package/dist/types/services/rpc/logbook.d.ts

@@ -5,24 +5,25 @@ export declare namespace LogbookService {
             oldUUID: string;
             newUUID: string;
         }
-        export interface ILogbookSyncRequest {
-            lastSyncTimestamp: string;
+        interface ICursor {
+            created?: ICreatedCursor;
+            deleted?: string;
+        }
+        interface ICreatedCursor {
+            cursor: string;
+            hasMore: boolean;
+        }
+        export interface ILogbookServiceRequest {
+            cursor?: ICursor;
             created: Array<Logbook.Types.ILogbookEntry>;
             edited: Array<IEditedUUID>;
             deleted: Array<string>;
         }
-        export interface ILogbookSyncResponse {
-            lastSyncTimestamp: string;
+        export interface ILogbookServiceResponse {
+            cursor?: ICursor;
             created: Array<Logbook.Types.ILogbookEntry>;
             deleted: Array<string>;
         }
-        export interface ILogbookGetRequest {
-            cursor?: string;
-        }
-        export interface ILogbookGetResponse {
-            cursor?: string;
-            logbooks: Array<Logbook.Types.ILogbookEntry>;
-        }
         export {};
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hedia/types",
-  "version": "2.1.49-alpha.0",
+  "version": "2.1.49-alpha.1",
   "description": "Enums, interfaces, and other common types for use in Hedia's software.",
   "main": "dist/index.js",
   "repository": {
@@ -8,15 +8,20 @@
     "url": "git+ssh://git@github.com:hedia-team/hedia-types.git"
   },
   "scripts": {
-    "tsc": "tsc --build",
     "clean": "tsc --build --clean",
-    "postpublish": "npm run clean"
+    "lint": "tslint --project .",
+    "postpublish": "npm run clean",
+    "prettier": "prettier --check \"types/**/*.{ts,tsx}\"",
+    "tsc": "tsc --build"
   },
   "keywords": [],
   "author": "Hedia",
   "license": "ISC",
   "homepage": "https://github.com/hedia-team/hedia-types#readme",
   "devDependencies": {
+    "prettier": "^2.4.1",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
     "typescript": "4.1.5"
   }
 }

package/tslint.json

@@ -0,0 +1,181 @@
+{
+    "defaultSeverity": "error",
+    "extends": ["tslint:recommended", "tslint-config-prettier"],
+    "rules": {
+        "adjacent-overload-signatures": true,
+        "align": true,
+        "array-type": [true, "generic"],
+        "arrow-parens": true,
+        "arrow-return-shorthand": true,
+        "await-promise": [true, "Bluebird"],
+        "ban": false,
+        "ban-comma-operator": true,
+        "ban-types": false,
+        "binary-expression-operand-order": true,
+        "callable-types": true,
+        "class-name": true,
+        "comment-format": true,
+        "completed-docs": false,
+        "curly": true,
+        "cyclomatic-complexity": false,
+        "deprecation": false,
+        "encoding": true,
+        "eofline": true,
+        "file-header": false,
+        "file-name-casing": [false, "pascal-case"],
+        "forin": true,
+        "import-blacklist": false,
+        "import-spacing": true,
+        "indent": [true, "tabs", 4],
+        "interface-name": true,
+        "interface-over-type-literal": true,
+        "jsdoc-format": false,
+        "label-position": true,
+        "linebreak-style": [true, "LF"],
+        "match-default-export-name": true,
+        "max-classes-per-file": false,
+        "max-file-line-count": false,
+        "max-line-length": [true, { "limit": 120, "ignore-pattern": "// |^(\\s*)\\* |^(\\s*)\\/*" }],
+        "member-access": true,
+        "member-ordering": [
+            true,
+            {
+                "order": [
+                    "public-static-field",
+                    "protected-static-field",
+                    "private-static-field",
+                    "public-instance-field",
+                    "protected-instance-field",
+                    "private-instance-field",
+                    "public-constructor",
+                    "protected-constructor",
+                    "private-constructor",
+                    "public-instance-method",
+                    "protected-instance-method",
+                    "private-instance-method",
+                    "public-static-method",
+                    "protected-static-method",
+                    "private-static-method"
+                ]
+            }
+        ],
+        "new-parens": true,
+        "newline-before-return": false,
+        "newline-per-chained-call": false,
+        "no-angle-bracket-type-assertion": false,
+        "no-any": true,
+        "no-arg": true,
+        "no-bitwise": false,
+        "no-boolean-literal-compare": true,
+        "no-conditional-assignment": false,
+        "no-consecutive-blank-lines": true,
+        "no-console": [true, "log"],
+        "no-construct": true,
+        "no-debugger": false,
+        "no-default-export": false,
+        "no-duplicate-imports": true,
+        "no-duplicate-super": true,
+        "no-duplicate-switch-case": true,
+        "no-duplicate-variable": true,
+        "no-dynamic-delete": false,
+        "no-empty": true,
+        "no-empty-interface": true,
+        "no-eval": true,
+        "no-floating-promises": true,
+        "no-for-in-array": true,
+        "no-implicit-dependencies": false,
+        "no-import-side-effect": true,
+        "no-inferrable-types": false,
+        "no-inferred-empty-object-type": true,
+        "no-internal-module": true,
+        "no-invalid-template-strings": true,
+        "no-invalid-this": true,
+        "no-irregular-whitespace": true,
+        "no-magic-numbers": false,
+        "no-mergeable-namespace": true,
+        "no-misused-new": true,
+        "no-namespace": false,
+        "no-non-null-assertion": false,
+        "no-null-keyword": false,
+        "no-object-literal-type-assertion": true,
+        "no-parameter-properties": true,
+        "no-parameter-reassignment": true,
+        "no-redundant-jsdoc": true,
+        "no-reference": true,
+        "no-reference-import": true,
+        "no-require-imports": false,
+        "no-return-await": false,
+        "no-shadowed-variable": true,
+        "no-sparse-arrays": true,
+        "no-string-literal": true,
+        "no-string-throw": true,
+        "no-submodule-imports": false,
+        "no-switch-case-fall-through": true,
+        "no-this-assignment": true,
+        "no-trailing-whitespace": true,
+        "no-unbound-method": false,
+        "no-unnecessary-callback-wrapper": true,
+        "no-unnecessary-class": false,
+        "no-unnecessary-initializer": true,
+        "no-unnecessary-qualifier": true,
+        "no-unnecessary-type-assertion": true,
+        "no-unsafe-any": false,
+        "no-unsafe-finally": true,
+        "no-unused-expression": true,
+        "no-use-before-declare": false,
+        "no-var-keyword": true,
+        "no-var-requires": false,
+        "no-void-expression": false,
+        "number-literal-format": false,
+        "object-literal-key-quotes": [true, "as-needed"],
+        "object-literal-shorthand": true,
+        "object-literal-sort-keys": false,
+        "one-line": [true, "check-catch", "check-finally", "check-else", "check-open-brace"],
+        "one-variable-per-declaration": true,
+        "only-arrow-functions": false,
+        "ordered-imports": true,
+        "prefer-conditional-expression": true,
+        "prefer-const": true,
+        "prefer-for-of": false,
+        "prefer-function-over-method": false,
+        "prefer-method-signature": true,
+        "prefer-object-spread": false,
+        "prefer-readonly": true,
+        "prefer-switch": false,
+        "prefer-template": true,
+        "prefer-while": true,
+        "promise-function-async": true,
+        "quotemark": [true, "double" ,"backtick"],
+        "radix": true,
+        "restrict-plus-operands": true,
+        "return-undefined": true,
+        "semicolon": [true, "always", "ignore-bound-class-methods"],
+        "space-before-function-paren": [true, { "anonymous": "never", "named": "never", "asyncArrow": "always" }],
+        "space-within-parens": [true, { "type": "number", "min": 0, "max": 0 }],
+        "strict-boolean-expressions": false,
+        "strict-type-predicates": false,
+        "switch-default": true,
+        "switch-final-break": false,
+        "trailing-comma": [true, { "multiline": "always", "singleline": "never", "esSpecCompliant": true }],
+        "triple-equals": [true, "allow-undefined-check"],
+        "type-literal-delimiter": true,
+        "typedef": true,
+        "typedef-whitespace": true,
+        "unified-signatures": true,
+        "use-default-type-parameter": true,
+        "use-isnan": true,
+        "variable-name": [true, "require-const-for-all-caps", "ban-keywords"],
+        "whitespace": [
+            true,
+            "check-decl",
+            "check-branch",
+            "check-operator",
+            "check-module",
+            "check-separator",
+            "check-rest-spread",
+            "check-type",
+            "check-typecast",
+            "check-type-operator"
+        ]
+    }
+}

package/types/activity/activity.ts

@@ -31,9 +31,11 @@ export namespace Activity {
 			[key in ActivityIntensityKeys]: ActivityReductionSettingsIntervals<key, "hard", "fromFortysix">;
 		};
 
+		// tslint:disable-next-line: interface-over-type-literal
 		type ActivityPostReduction = {
 			post: { [key in ActivityReductionKeys]: number };
 		};
+		// tslint:disable-next-line: interface-over-type-literal
 		type ActivityTarget = {
 			target: number;
 		};

package/types/services/rpc/logbook.ts

@@ -7,26 +7,27 @@ export namespace LogbookService {
 			newUUID: string;
 		}
 
-		export interface ILogbookSyncRequest {
-			lastSyncTimestamp: string;
+		interface ICursor {
+			created?: ICreatedCursor;
+			deleted?: string;
+		}
+
+		interface ICreatedCursor {
+			cursor: string;
+			hasMore: boolean;
+		}
+
+		export interface ILogbookServiceRequest {
+			cursor?: ICursor;
 			created: Array<Logbook.Types.ILogbookEntry>;
 			edited: Array<IEditedUUID>;
 			deleted: Array<string>;
 		}
 
-		export interface ILogbookSyncResponse {
-			lastSyncTimestamp: string;
+		export interface ILogbookServiceResponse {
+			cursor?: ICursor;
 			created: Array<Logbook.Types.ILogbookEntry>;
 			deleted: Array<string>;
 		}
-
-		export interface ILogbookGetRequest {
-			cursor?: string;
-		}
-
-		export interface ILogbookGetResponse {
-			cursor?: string;
-			logbooks: Array<Logbook.Types.ILogbookEntry>;
-		}
 	}
 }