public class | source

OpsUtil

You can directly use an instance of this class. opsUtil

Extends:

cables-shared-api~SharedOpsUtil → OpsUtil

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	PREFIX_LOCAL_OPS: string

Method Summary

Public Methods
public	addPermissionsToOps(opDocs: , user: , teams: [], project: undefined):
public	getCollectionName(opName: ):
public	getOpAbsolutePath(opName: ):
public	getOpAssetPorts(op: , includeLibraryAssets: boolean):
public	getOpNameByAbsoluteFileName(fileName: *): string
public	getOpNpmPackages(opName: ):
public	getOpRenameConsequences(newName: , oldName: , targetDir: undefined): *[]
public	getOpRenameProblems(newName: , oldName: , userObj: , teams: [], newOpProject: undefined, oldOpProject: undefined, opUsages: *[], checkUsages: boolean, targetDir: undefined): OpRenameProblems
public	getOpSourceDir(opName: , relative: boolean):
public	getOpSourceNoHierarchy(opName: , relative: boolean):
public	getOpTargetDir(opName: , relative: boolean):
public	getPatchOpNamespace(opName: ):
public	getPatchOpsNamespaceForProject(proj: ):
public	isCoreOp(opName: ):
public	isLocalOp(opName: ):
public	renameToCoreOp(oldName: , newName: , currentUser: , cb: undefined):
public	renameToExtensionOp(oldName: , newName: , currentUser: , cb: undefined):
public	renameToPatchOp(oldName: , newName: , currentUser: , removeOld: , newId: , cb: undefined):
public	renameToTeamOp(oldName: , newName: , currentUser: , cb: undefined):
public	renameToUserOp(oldName: , newName: , currentUser: , cb: undefined):
public	updateOpCode(opName: , author: , code: ):
public	userHasReadRightsOp(user: , opName: , teams: undefined, project: undefined, opOwner: undefined): boolean
public	userHasWriteRightsOp(user: , opName: , teams: *[], project: undefined, ignoreAdmin: boolean): boolean
public	validateAndFormatOpCode(code: ): {"formatedCode": , "error": , "message": }

Public Constructors

public constructor() source

Public Members

public PREFIX_LOCAL_OPS: string source

Public Methods

public addPermissionsToOps(opDocs: , user: , teams: [], project: undefined): source

Params:

Name	Type	Attribute	Description
opDocs	*
user	*
teams	*[]	optional default: []
project	undefined	optional default: undefined

Return:

public getCollectionName(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public getOpAbsolutePath(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public getOpAssetPorts(op: , includeLibraryAssets: boolean): source

Params:

Name	Type	Attribute	Description
op	*
includeLibraryAssets	boolean	optional default: false

Return:

public getOpNameByAbsoluteFileName(fileName: *): string source

Params:

Name	Type	Attribute	Description
fileName	*

Return:

string

public getOpNpmPackages(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public getOpRenameConsequences(newName: , oldName: , targetDir: undefined): *[] source

Params:

Name	Type	Attribute	Description
newName	*
oldName	*
targetDir	undefined	optional default: undefined

Return:

*[]

public getOpRenameProblems(newName: , oldName: , userObj: , teams: [], newOpProject: undefined, oldOpProject: undefined, opUsages: *[], checkUsages: boolean, targetDir: undefined): OpRenameProblems source

Params:

Name	Type	Attribute	Description
newName	*
oldName	*
userObj	*
teams	*[]	optional default: []
newOpProject	undefined	optional default: undefined
oldOpProject	undefined	optional default: undefined
opUsages	*[]	optional default: []
checkUsages	boolean	optional default: true
targetDir	undefined	optional default: undefined

Return:

OpRenameProblems

public getOpSourceDir(opName: , relative: boolean): source

Params:

Name	Type	Attribute	Description
opName	*
relative	boolean	optional default: false

Return:

public getOpSourceNoHierarchy(opName: , relative: boolean): source

Params:

Name	Type	Attribute	Description
opName	*
relative	boolean	optional default: false

Return:

public getOpTargetDir(opName: , relative: boolean): source

Params:

Name	Type	Attribute	Description
opName	*
relative	boolean	optional default: false

Return:

public getPatchOpNamespace(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public getPatchOpsNamespaceForProject(proj: ): source

Params:

Name	Type	Attribute	Description
proj	*

Return:

public isCoreOp(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public isLocalOp(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public renameToCoreOp(oldName: , newName: , currentUser: , cb: undefined): source

Params:

Name	Type	Attribute	Description
oldName	*
newName	*
currentUser	*
cb	undefined	optional default: undefined

Return:

public renameToExtensionOp(oldName: , newName: , currentUser: , cb: undefined): source

Params:

Name	Type	Attribute	Description
oldName	*
newName	*
currentUser	*
cb	undefined	optional default: undefined

Return:

public renameToPatchOp(oldName: , newName: , currentUser: , removeOld: , newId: , cb: undefined): source

Params:

Name	Type	Attribute	Description
oldName	*
newName	*
currentUser	*
removeOld	*
newId	*
cb	undefined	optional default: undefined

Return:

public renameToTeamOp(oldName: , newName: , currentUser: , cb: undefined): source

Params:

Name	Type	Attribute	Description
oldName	*
newName	*
currentUser	*
cb	undefined	optional default: undefined

Return:

public renameToUserOp(oldName: , newName: , currentUser: , cb: undefined): source

Params:

Name	Type	Attribute	Description
oldName	*
newName	*
currentUser	*
cb	undefined	optional default: undefined

Return:

public updateOpCode(opName: , author: , code: ): source

Params:

Name	Type	Attribute	Description
opName	*
author	*
code	*

Return:

public userHasReadRightsOp(user: , opName: , teams: undefined, project: undefined, opOwner: undefined): boolean source

Params:

Name	Type	Attribute	Description
user	*
opName	*
teams	undefined	optional default: undefined
project	undefined	optional default: undefined
opOwner	undefined	optional default: undefined

Return:

boolean

public userHasWriteRightsOp(user: , opName: , teams: *[], project: undefined, ignoreAdmin: boolean): boolean source

Params:

Name	Type	Attribute	Description
user	*
opName	*
teams	*[]	optional default: []
project	undefined	optional default: undefined
ignoreAdmin	boolean	optional default: false

Return:

boolean

public validateAndFormatOpCode(code: ): {"formatedCode": , "error": , "message": } source

Params:

Name	Type	Attribute	Description
code	*

Return:

{"formatedCode": *, "error": *, "message": *}

OpsUtil

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public PREFIX_LOCAL_OPS: string source

Public Methods

public addPermissionsToOps(opDocs: *, user: *, teams: *[], project: undefined): * source

Params:

Return:

public getCollectionName(opName: *): * source

Params:

Return:

public getOpAbsolutePath(opName: *): * source

Params:

Return:

public getOpAssetPorts(op: *, includeLibraryAssets: boolean): * source

Params:

Return:

public getOpNameByAbsoluteFileName(fileName: *): string source

Params:

Return:

public getOpNpmPackages(opName: *): * source

Params:

Return:

public getOpRenameConsequences(newName: *, oldName: *, targetDir: undefined): *[] source

Params:

Return:

public getOpRenameProblems(newName: *, oldName: *, userObj: *, teams: *[], newOpProject: undefined, oldOpProject: undefined, opUsages: *[], checkUsages: boolean, targetDir: undefined): OpRenameProblems source

Params:

Return:

public getOpSourceDir(opName: *, relative: boolean): * source

Params:

Return:

public getOpSourceNoHierarchy(opName: *, relative: boolean): * source

Params:

Return:

public getOpTargetDir(opName: *, relative: boolean): * source

Params:

Return:

public getPatchOpNamespace(opName: *): * source

Params:

Return:

public getPatchOpsNamespaceForProject(proj: *): * source

Params:

Return:

public isCoreOp(opName: *): * source

Params:

Return:

public isLocalOp(opName: *): * source

Params:

Return:

public renameToCoreOp(oldName: *, newName: *, currentUser: *, cb: undefined): * source

Params:

Return:

public renameToExtensionOp(oldName: *, newName: *, currentUser: *, cb: undefined): * source

Params:

Return:

public renameToPatchOp(oldName: *, newName: *, currentUser: *, removeOld: *, newId: *, cb: undefined): * source

Params:

Return:

public renameToTeamOp(oldName: *, newName: *, currentUser: *, cb: undefined): * source

Params:

Return:

public renameToUserOp(oldName: *, newName: *, currentUser: *, cb: undefined): * source

Params:

Return:

public updateOpCode(opName: *, author: *, code: *): * source

Params:

Return:

public userHasReadRightsOp(user: *, opName: *, teams: undefined, project: undefined, opOwner: undefined): boolean source

Params:

Return:

public userHasWriteRightsOp(user: *, opName: *, teams: *[], project: undefined, ignoreAdmin: boolean): boolean source

Params:

Return:

public validateAndFormatOpCode(code: *): {"formatedCode": *, "error": *, "message": *} source

public addPermissionsToOps(opDocs: , user: , teams: [], project: undefined): source

public getCollectionName(opName: ): source

public getOpAbsolutePath(opName: ): source

public getOpAssetPorts(op: , includeLibraryAssets: boolean): source

public getOpNpmPackages(opName: ): source

public getOpRenameConsequences(newName: , oldName: , targetDir: undefined): *[] source

public getOpRenameProblems(newName: , oldName: , userObj: , teams: [], newOpProject: undefined, oldOpProject: undefined, opUsages: *[], checkUsages: boolean, targetDir: undefined): OpRenameProblems source

public getOpSourceDir(opName: , relative: boolean): source

public getOpSourceNoHierarchy(opName: , relative: boolean): source

public getOpTargetDir(opName: , relative: boolean): source

public getPatchOpNamespace(opName: ): source

public getPatchOpsNamespaceForProject(proj: ): source

public isCoreOp(opName: ): source

public isLocalOp(opName: ): source

public renameToCoreOp(oldName: , newName: , currentUser: , cb: undefined): source

public renameToExtensionOp(oldName: , newName: , currentUser: , cb: undefined): source

public renameToPatchOp(oldName: , newName: , currentUser: , removeOld: , newId: , cb: undefined): source

public renameToTeamOp(oldName: , newName: , currentUser: , cb: undefined): source

public renameToUserOp(oldName: , newName: , currentUser: , cb: undefined): source

public updateOpCode(opName: , author: , code: ): source

public userHasReadRightsOp(user: , opName: , teams: undefined, project: undefined, opOwner: undefined): boolean source

public userHasWriteRightsOp(user: , opName: , teams: *[], project: undefined, ignoreAdmin: boolean): boolean source

public validateAndFormatOpCode(code: ): {"formatedCode": , "error": , "message": } source