TypeScript!

lib/types.ts

@@ -0,0 +1,305 @@
+import PathSet from "./path-set";
+import VersionedMap from "./versioned-map";
+import InstanceSet from "./instance-set";
+import { IncomingMessage, ServerResponse } from "http";
+
+export interface ParamPath extends Array<any> {
+  wildcard: number;
+  alias: number;
+}
+
+export type Expression = string | number | boolean | null | any[];
+
+export interface Fault {
+  code: string;
+  message: string;
+  detail?: {
+    name: string;
+    message: string;
+    stack?: string;
+  };
+}
+
+export interface SessionFault extends Fault {
+  channel: string;
+  timestamp: number;
+  provisions: string[][];
+  retryNow?: boolean;
+  precondition?: boolean;
+  retries?: number;
+  expiry?: number;
+}
+
+export interface Attributes {
+  object?: [number, 1 | 0];
+  writable?: [number, 1 | 0];
+  value?: [number, [string | number | boolean, string]];
+}
+
+export interface AttributeTimestamps {
+  object?: number;
+  writable?: number;
+  value?: number;
+}
+
+export interface AttributeValues {
+  object?: boolean;
+  writable?: boolean;
+  value?: [string | number | boolean, string?];
+}
+
+export interface DeviceData {
+  paths: PathSet;
+  timestamps: VersionedMap<ParamPath, number>;
+  attributes: VersionedMap<ParamPath, Attributes>;
+  loaded: Map<ParamPath, number>;
+  trackers: Map<ParamPath, { [name: string]: number }>;
+  changes: Set<string>;
+}
+
+export type VirtualParameterDeclaration = [
+  ParamPath,
+  { path?: number; object?: number; writable?: number; value?: number }?,
+  {
+    path?: [number, number];
+    object?: boolean;
+    writable?: boolean;
+    value?: [string | number | boolean, string?];
+  }?
+];
+
+export interface SyncState {
+  refreshAttributes: {
+    exist: Set<ParamPath>;
+    object: Set<ParamPath>;
+    writable: Set<ParamPath>;
+    value: Set<ParamPath>;
+  };
+  spv: Map<ParamPath, [string | number | boolean, string]>;
+  gpn: Set<ParamPath>;
+  gpnPatterns: Map<ParamPath, number>;
+  tags: Map<ParamPath, [string | number | boolean, string]>;
+  virtualParameterDeclarations: VirtualParameterDeclaration[][];
+  instancesToDelete: Map<ParamPath, Set<ParamPath>>;
+  instancesToCreate: Map<ParamPath, InstanceSet>;
+  downloadsToDelete: Set<ParamPath>;
+  downloadsToCreate: InstanceSet;
+  downloadsValues: Map<ParamPath, string | number>;
+  downloadsDownload: Map<ParamPath, number>;
+}
+
+export interface SessionContext {
+  sessionId?: string;
+  timestamp: number;
+  deviceId: string;
+  deviceData: DeviceData;
+  cwmpVersion: string;
+  timeout: number;
+  provisions: any[];
+  channels: { [channel: string]: number };
+  virtualParameters: any[];
+  revisions: number[];
+  rpcCount: number;
+  iteration: number;
+  cycle: number;
+  extensionsCache: any;
+  declarations: any[];
+  faults?: { [channel: string]: SessionFault };
+  retries?: { [channel: string]: number };
+  cacheSnapshot?: string;
+  configContext?: { [name: string]: any };
+  httpResponse?: ServerResponse;
+  httpRequest?: IncomingMessage;
+  faultsTouched?: { [channel: string]: boolean };
+  presetCycles?: number;
+  toLoad?: Map<ParamPath, number>;
+  new?: boolean;
+  debug?: boolean;
+  tasks?: Task[];
+  operations?: { [commandKey: string]: Operation };
+  cacheUntil?: number;
+  syncState?: SyncState;
+  lastActivity?: number;
+  rpcRequest?: AcsRequest;
+  operationsTouched?: { [commandKey: string]: 1 | 0 };
+  provisionsRet?: any[];
+  doneTasks?: string[];
+}
+
+export interface Task {
+  _id: string;
+  name: string;
+  parameterNames?: string[];
+  parameterValues?: [string, string | number | boolean, string?][];
+  objectName?: string;
+  fileType?: string;
+  fileName?: string;
+  targetFileName?: string;
+  expiry?: number;
+}
+
+export interface Operation {
+  name: string;
+  timestamp: number;
+  provisions: string[][];
+  channels: { [channel: string]: number };
+  retries: { [channel: string]: number };
+  args: {
+    instance: string;
+    fileType: string;
+    fileName: string;
+    targetFileName: string;
+  };
+}
+
+export interface AcsRequest {
+  name: string;
+}
+
+export interface GetAcsRequest extends AcsRequest {
+  name: "GetParameterNames" | "GetParameterValues";
+  objectName?: string;
+  parameterNames?: string[];
+  parameterPath?: string;
+  nextLevel?: boolean;
+}
+
+export interface SetAcsRequest extends AcsRequest {
+  name:
+    | "SetParameterValues"
+    | "AddObject"
+    | "DeleteObject"
+    | "FactoryReset"
+    | "Reboot"
+    | "Download";
+  parameterList?: [string, string | number | boolean, string][];
+  instanceValues?: { [param: string]: string | number | boolean };
+  objectName?: string;
+  next?: string;
+  DATETIME_MILLISECONDS?: boolean;
+  BOOLEAN_LITERAL?: boolean;
+  commandKey?: string;
+  instance?: string;
+  fileType?: string;
+  fileSize?: number;
+  url?: string;
+  fileName?: string;
+  targetFileName?: string;
+}
+
+export interface CpeResponse {
+  name: string;
+}
+
+export interface SpvFault {
+  parameterName: string;
+  faultCode: string;
+  faultString: string;
+}
+
+export interface FaultStruct {
+  faultCode: string;
+  faultString: string;
+  setParameterValuesFault?: SpvFault[];
+}
+
+export interface CpeFault {
+  faultCode: string;
+  faultString: string;
+  detail?: FaultStruct;
+}
+
+export interface CpeGetResponse extends CpeResponse {
+  name: "GetParameterNamesResponse" | "GetParameterValuesResponse";
+  parameterList?:
+    | [string, boolean][]
+    | [string, string | number | boolean, string][];
+}
+
+export interface CpeSetResponse extends CpeResponse {
+  name:
+    | "SetParameterValuesResponse"
+    | "AddObjectResponse"
+    | "DeleteObjectResponse"
+    | "RebootResponse"
+    | "FactoryResetResponse"
+    | "DownloadResponse";
+  status?: number;
+  instanceNumber?: string;
+  startTime?: number;
+  completeTime?: number;
+}
+
+export interface CpeRequest {
+  name: string;
+  fileType?: string;
+}
+
+export interface InformRequest extends CpeRequest {
+  name: "Inform";
+  deviceId: {
+    Manufacturer: string;
+    OUI: string;
+    ProductClass?: string;
+    SerialNumber: string;
+  };
+  event: string[];
+  retryCount: number;
+  parameterList: [string, string | number | boolean, string][];
+}
+
+export interface AcsResponse {
+  name: string;
+  commandKey?: string;
+  faultStruct?: FaultStruct;
+  startTime?: number;
+  completeTime?: number;
+}
+
+export interface QueryOptions {
+  projection?: any;
+  skip?: number;
+  limit?: number;
+  sort?: {
+    [param: string]: number;
+  };
+}
+
+export interface Declaration {
+  path: ParamPath;
+  pathGet: number;
+  pathSet?: [number, number];
+  attrGet?: { object?: number; writable?: number; value?: number };
+  attrSet?: {
+    object?: boolean;
+    writable?: boolean;
+    value?: [string | number | boolean, string?];
+  };
+  defer: boolean;
+}
+
+export type Clear = [
+  ParamPath,
+  number,
+  { object?: number; writable?: number; value?: number }?,
+  number?
+];
+
+export interface Preset {
+  name: string;
+  channel: string;
+  schedule?: { md5: string; duration: number; schedule: any };
+  events?: { [event: string]: boolean };
+  precondition?: {};
+  provisions: string[][];
+}
+
+export type PermissionSet = {
+  [resource: string]: {
+    access: number;
+    validate?: {
+      [validator: string]: boolean;
+    };
+    filter: Expression;
+  };
+}[];