enonic-types - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

controller.d.ts

@@ -12,3 +12,5 @@ export declare interface Request {
     readonly body: string;
-    readonly params: Params;
+    readonly params: {
+        readonly [key: string]: string | undefined;
+    };
     readonly headers: {
@@ -23,3 +25,3 @@ readonly [key: string]: string | undefined;
 export declare interface Response {
-    readonly status: number;
+    readonly status?: number;
     readonly body?: ResponseType;
@@ -38,5 +40,2 @@ readonly contentType?: string;
 }
-export declare type Params = {
-    readonly [key: string]: string | ReadonlyArray<string> | undefined;
-};
 export interface MacroContext<A = never> {
@@ -65,2 +64,11 @@ readonly name: string;
 /**
+ * Request where params potentially are typed as Arrays, reflecting the real
+ * behaviour of XP, instead of the common use case.
+ */
+export declare type RequestWithArrayParams = Omit<Request, 'params'> & {
+    params: {
+        readonly [key: string]: string | ReadonlyArray<string> | undefined;
+    };
+};
+/**
  * Request object to be used with functions in "error.ts"
@@ -67,0 +75,0 @@ */

index.d.ts

@@ -22,2 +22,3 @@ export interface EnonicLibraryMap {
     "/lib/xp/value": import("./value").ValueLibrary;
+    "/lib/xp/websocket": import("./websocket").WebsocketLibrary;
 }

package.json

 {
   "name": "enonic-types",
   "sideEffects": false,
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "TypeScript types for Enonic XP",
@@ -29,3 +29,3 @@ "typings": "index.d.ts",
     "@typescript-eslint/parser": "^4.1.0",
-    "eslint": "^7.8.1",
+    "eslint": "^7.9.0",
     "rimraf": "^3.0.2",
@@ -32,0 +32,0 @@ "typescript": "^4.0.2"

portal.d.ts

 import { ByteSource, Content, Site } from "./content";
-import { Params } from "./controller";
 import { XOR } from "./types";
+export declare type Params = {
+    readonly [key: string]: string | ReadonlyArray<string> | undefined;
+};
 export interface Component<A> {
@@ -5,0 +7,0 @@ readonly path: string;

project.d.ts

 export interface ProjectLibrary {
     /**
-     * Adds permissions to an existing Content Project. To modify permissions, user must have Owner permissions for the project, or either system.admin or cms.admin role.
+     * Adds permissions to an existing Content Project. To modify permissions, user must have Owner permissions for the
+     * project, or either system.admin or cms.admin role.
      */
@@ -11,23 +12,30 @@ addPermissions(params: AddPermissionsParams): boolean;
     /**
-     * Deletes an existing Content Project and the project repository along with all the data inside. To delete a project, user must have either system.admin or cms.admin role.
+     * Deletes an existing Content Project and the project repository along with all the data inside. To delete a project,
+     * user must have either system.admin or cms.admin role.
      */
     delete(params: DeleteProjectParams): boolean;
     /**
-     * Returns an existing Content Project. To get a project, user must have permissions for this project, or either system.admin or cms.admin role.
+     * Returns an existing Content Project. To get a project, user must have permissions for this project, or either
+     * system.admin or cms.admin role.
      */
     get(params: GetProjectParams): Project | null;
     /**
-     * Returns all Content Projects that user in the current context has permissions for. Users with system.admin or cms.admin roles will get the list of all projects.
+     * Returns all Content Projects that user in the current context has permissions for. Users with system.admin or
+     * cms.admin roles will get the list of all projects.
      */
     list(): ReadonlyArray<Project>;
     /**
-     * Modifies an existing Content Project. To modify a project, user must have Owner permissions for this project, or either system.admin or cms.admin role.
+     * Modifies an existing Content Project. To modify a project, user must have Owner permissions for this project,
+     * or either system.admin or cms.admin role.
      */
     modify(params: ModifyProjectParams): Project;
     /**
-     * Toggles public/private READ access for an existing Content Project. This will modify permissions on ALL the content items inside the project repository by adding or removing READ access for system.everyone. To modify READ access, user must have Owner permissions for the project, or either system.admin or cms.admin role.
+     * Toggles public/private READ access for an existing Content Project. This will modify permissions on ALL the
+     * content items inside the project repository by adding or removing READ access for system.everyone. To modify READ
+     * access, user must have Owner permissions for the project, or either system.admin or cms.admin role.
      */
     modifyReadAccess(params: ModifyReadAccessParams): ModifyReadAccessResult;
     /**
-     * Removes permissions from an existing Content Project. To remove permissions, user must have Owner permissions for the project, or either system.admin or cms.admin role.
+     * Removes permissions from an existing Content Project. To remove permissions, user must have Owner permissions for
+     * the project, or either system.admin or cms.admin role.
      */
@@ -34,0 +42,0 @@ removePermissions(params: RemovePermissionsParams): boolean;

README.md

@@ -80,1 +80,2 @@ # TypeScript types for Enonic XP
  * [ValueLibrary](./src/value.ts)
+ * [WebsocketLibrary](./src/websocket.ts)

No alert changes

Improved metrics

Total package byte prevSize

61137

increased by0.8%

Lines of code

1750

increased by1.04%

Number of lines in readme file

81

increased by1.25%

No dependency changes