Comparing version 1.8.5 to 1.9.0
@@ -43,2 +43,3 @@ export interface Global { | ||
export declare type EasingType = 'EASE_IN' /** Ease in with an animation curve similar to CSS ease-in */ | 'EASE_OUT' /** Ease out with an animation curve similar to CSS ease-out */ | 'EASE_IN_AND_OUT'; /** Ease in and then out with an animation curve similar to CSS ease-in-out */ | ||
export declare type RoleType = 'viewer' | 'editor' | 'owner'; | ||
export declare type NodeType = 'DOCUMENT' | 'CANVAS' | 'FRAME' | 'GROUP' | 'VECTOR' | 'BOOLEAN' | 'STAR' | 'LINE' | 'ELLIPSE' | 'REGULAR_POLYGON' | 'RECTANGLE' | 'TEXT' | 'SLICE' | 'COMPONENT' | 'INSTANCE'; | ||
@@ -605,12 +606,7 @@ export declare type Node = Document | Canvas | Frame | Group | Vector | BooleanGroup | Star | Line | Ellipse | RegularPolygon | Rectangle | Text | Slice | Component | Instance; | ||
} | ||
/** A relative offset within a frame */ | ||
export interface FrameOffset { | ||
/** Unique id specifying the frame */ | ||
readonly node_id: string; | ||
/** 2d vector offset within the frame */ | ||
readonly node_offset: Vector2; | ||
} | ||
interface SharedElement extends ComponentMetadata { | ||
/** The unique identifier of the figma file which contains the element */ | ||
readonly file_key: string; | ||
/** Id of the component node within the figma file */ | ||
readonly node_id: string; | ||
/** URL link to the element's thumbnail image */ | ||
@@ -688,2 +684,9 @@ readonly thumbnail_urlString: string; | ||
} | ||
/** A relative offset within a frame */ | ||
export interface FrameOffset { | ||
/** Unique id specifying the frame */ | ||
readonly node_id: string; | ||
/** 2d vector offset within the frame */ | ||
readonly node_offset: Vector2; | ||
} | ||
export interface ProjectSummary { | ||
@@ -703,2 +706,3 @@ readonly id: string; | ||
readonly name: string; | ||
readonly role: RoleType; | ||
readonly schemaVersion: number; | ||
@@ -723,2 +727,3 @@ readonly thumbnailUrl: string; | ||
readonly name: string; | ||
readonly role: RoleType; | ||
readonly thumbnailUrl: string; | ||
@@ -760,2 +765,15 @@ readonly version: string; | ||
} | ||
export interface ComponentResponse { | ||
readonly err: string | null; | ||
readonly status: number; | ||
readonly meta: { | ||
readonly [key: string]: FullComponentMetadata; | ||
}; | ||
} | ||
export interface StyleResponse { | ||
readonly err: string | null; | ||
readonly meta: { | ||
readonly [key: string]: FullStyleMetadata; | ||
}; | ||
} | ||
export interface FileSummary { | ||
@@ -768,5 +786,7 @@ readonly key: string; | ||
export interface TeamProjectsResponse { | ||
readonly name: string; | ||
readonly projects: ReadonlyArray<ProjectSummary>; | ||
} | ||
export interface ProjectFilesResponse { | ||
readonly name: string; | ||
readonly files: ReadonlyArray<FileSummary>; | ||
@@ -783,5 +803,11 @@ } | ||
} | ||
export interface FileComponentsResponse extends PaginationResponse { | ||
readonly components: ReadonlyArray<FullComponentMetadata>; | ||
} | ||
export interface TeamStylesResponse extends PaginationResponse { | ||
readonly styles: ReadonlyArray<FullStyleMetadata>; | ||
} | ||
export interface FileStylesResponse extends PaginationResponse { | ||
readonly styles: ReadonlyArray<FullStyleMetadata>; | ||
} | ||
export {}; |
@@ -63,3 +63,5 @@ import * as Figma from './figmaTypes'; | ||
/** The absolute canvas position of where to place the comment */ | ||
readonly client_meta: Figma.Vector2 | Figma.FrameOffset; | ||
readonly client_meta?: Figma.Vector2 | Figma.FrameOffset; | ||
/** The comment to reply to, if any. This must be a root comment, that is, you cannot reply to a comment that is a reply itself (a reply has a parent_id). */ | ||
readonly comment_id?: string; | ||
} | ||
@@ -155,3 +157,3 @@ export interface PaginationParams { | ||
* Posts a new comment on the file. | ||
* @param {fileId} String File to get comments from | ||
* @param {fileId} String File to post comment to | ||
* @param {params} PostCommentParams | ||
@@ -162,2 +164,9 @@ * @see https://www.figma.com/developers/api#post-comments-endpoint | ||
/** | ||
* Delete a comment from the file | ||
* @param {fileId} String File to delete comment from | ||
* @param {commentId} String id of the comment to be deleted | ||
* @see https://www.figma.com/developers/api#delete-comments-endpoint | ||
*/ | ||
readonly deleteComment: (fileId: string, commentId: string) => AxiosPromise<Figma.Comment>; | ||
/** | ||
* Get user information for the authenticated user. | ||
@@ -190,2 +199,8 @@ * @see https://www.figma.com/developers/api#get-me-endpoint | ||
/** | ||
* Get a paginated list of published components within a file | ||
* @param {fileId} String Id of the file to list components from | ||
* @see https://www.figma.com/developers/api#get-file-components-endpoint | ||
*/ | ||
readonly fileComponents: (fileId: string, params?: PaginationParams) => AxiosPromise<Figma.FileComponentsResponse>; | ||
/** | ||
* Get metadata on a component by key. | ||
@@ -195,6 +210,6 @@ * @param {key} The unique identifier of the component. | ||
*/ | ||
readonly component: (key: string) => AxiosPromise<Figma.FullComponentMetadata>; | ||
readonly component: (key: string) => AxiosPromise<Figma.ComponentResponse>; | ||
/** | ||
* Get a paginated list of published styles within a team library | ||
* @param {teamId} String Id of the team to list components from | ||
* @param {teamId} String Id of the team to list styles from | ||
* @see https://www.figma.com/developers/api#get-team-styles-endpoint | ||
@@ -204,2 +219,8 @@ */ | ||
/** | ||
* Get a paginated list of published styles within a file | ||
* @param {fileId} String Id of the file to list styles from | ||
* @see https://www.figma.com/developers/api#get-file-styles-endpoint | ||
*/ | ||
readonly fileStyles: (fileId: string, params?: PaginationParams) => AxiosPromise<Figma.FileStylesResponse>; | ||
/** | ||
* Get metadata on a style by key. | ||
@@ -209,4 +230,4 @@ * @param {key} The unique identifier of the style. | ||
*/ | ||
readonly style: (key: string) => AxiosPromise<Figma.FullStyleMetadata>; | ||
readonly style: (key: string) => AxiosPromise<Figma.StyleResponse>; | ||
} | ||
export declare const Client: (opts: ClientOptions) => ClientInterface; |
@@ -32,2 +32,3 @@ "use strict"; | ||
postComment: (fileId, params) => client.post(`files/${fileId}/comments`, params), | ||
deleteComment: (fileId, commentId) => client.delete(`files/${fileId}/comments/${commentId}`), | ||
me: () => client.get(`me`), | ||
@@ -37,7 +38,9 @@ teamProjects: teamId => client.get(`teams/${teamId}/projects`), | ||
teamComponents: (teamId, params = {}) => client.get(`teams/${teamId}/components`, { params }), | ||
fileComponents: (fileId, params = {}) => client.get(`files/${fileId}/components`, { params }), | ||
component: key => client.get(`components/${key}`), | ||
teamStyles: (teamId, params = {}) => client.get(`teams/${teamId}/styles`, { params }), | ||
fileStyles: (fileId, params = {}) => client.get(`files/${fileId}/styles`, { params }), | ||
style: key => client.get(`styles/${key}`) | ||
}; | ||
}; | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFHQSxrREFBMkQ7QUE4UDlDLFFBQUEsTUFBTSxHQUFHLENBQUMsSUFBbUIsRUFBbUIsRUFBRTtJQUM3RCxNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsV0FBVztRQUM5QixDQUFDLENBQUM7WUFDRSxhQUFhLEVBQUUsVUFBVSxJQUFJLENBQUMsV0FBVyxFQUFFO1NBQzVDO1FBQ0gsQ0FBQyxDQUFDO1lBQ0UsZUFBZSxFQUFFLElBQUksQ0FBQyxtQkFBbUI7U0FDMUMsQ0FBQztJQUVOLE1BQU0sTUFBTSxHQUFHLGVBQUssQ0FBQyxNQUFNLENBQUM7UUFDMUIsT0FBTyxFQUFFLFdBQVcsSUFBSSxDQUFDLE9BQU8sSUFBSSxlQUFlLE1BQU07UUFDekQsT0FBTztLQUNSLENBQUMsQ0FBQztJQUVILE9BQU87UUFDTCxNQUFNO1FBRU4sSUFBSSxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sR0FBRyxFQUFFLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLEVBQUUsRUFBRSxFQUFFLE1BQU0sRUFBRSxDQUFDO1FBRXhFLFlBQVksRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFdBQVcsQ0FBQztRQUU5RCxTQUFTLEVBQUUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLEVBQUUsQ0FDNUIsTUFBTSxDQUFDLEdBQUcsQ0FBQyxTQUFTLE1BQU0sUUFBUSxFQUFFO1lBQ2xDLE1BQU0sb0JBQ0QsTUFBTSxJQUNULEdBQUcsRUFBRSxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FDMUI7U0FDRixDQUFDO1FBRUosVUFBVSxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxFQUFFLENBQzdCLE1BQU0sQ0FBQyxHQUFHLENBQUMsVUFBVSxNQUFNLEVBQUUsRUFBRTtZQUM3QixNQUFNLG9CQUNELE1BQU0sSUFDVCxHQUFHLEVBQUUsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQzFCO1NBQ0YsQ0FBQztRQUVKLGNBQWMsRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFNBQVMsQ0FBQztRQUU5RCxRQUFRLEVBQUUsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFNBQVMsTUFBTSxXQUFXLENBQUM7UUFFMUQsV0FBVyxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxFQUFFLENBQzlCLE1BQU0sQ0FBQyxJQUFJLENBQUMsU0FBUyxNQUFNLFdBQVcsRUFBRSxNQUFNLENBQUM7UUFFakQsRUFBRSxFQUFFLEdBQUcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDO1FBRTFCLFlBQVksRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFdBQVcsQ0FBQztRQUU5RCxZQUFZLEVBQUUsU0FBUyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFlBQVksU0FBUyxRQUFRLENBQUM7UUFFcEUsY0FBYyxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sR0FBRyxFQUFFLEVBQUUsRUFBRSxDQUN0QyxNQUFNLENBQUMsR0FBRyxDQUFDLFNBQVMsTUFBTSxhQUFhLEVBQUUsRUFBRSxNQUFNLEVBQUUsQ0FBQztRQUV0RCxTQUFTLEVBQUUsR0FBRyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLGNBQWMsR0FBRyxFQUFFLENBQUM7UUFFakQsVUFBVSxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sR0FBRyxFQUFFLEVBQUUsRUFBRSxDQUNsQyxNQUFNLENBQUMsR0FBRyxDQUFDLFNBQVMsTUFBTSxTQUFTLEVBQUUsRUFBRSxNQUFNLEVBQUUsQ0FBQztRQUVsRCxLQUFLLEVBQUUsR0FBRyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFVBQVUsR0FBRyxFQUFFLENBQUM7S0FDMUMsQ0FBQztBQUNKLENBQUMsQ0FBQyJ9 | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFHQSxrREFBMkQ7QUE4UjlDLFFBQUEsTUFBTSxHQUFHLENBQUMsSUFBbUIsRUFBbUIsRUFBRTtJQUM3RCxNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsV0FBVztRQUM5QixDQUFDLENBQUM7WUFDRSxhQUFhLEVBQUUsVUFBVSxJQUFJLENBQUMsV0FBVyxFQUFFO1NBQzVDO1FBQ0gsQ0FBQyxDQUFDO1lBQ0UsZUFBZSxFQUFFLElBQUksQ0FBQyxtQkFBbUI7U0FDMUMsQ0FBQztJQUVOLE1BQU0sTUFBTSxHQUFHLGVBQUssQ0FBQyxNQUFNLENBQUM7UUFDMUIsT0FBTyxFQUFFLFdBQVcsSUFBSSxDQUFDLE9BQU8sSUFBSSxlQUFlLE1BQU07UUFDekQsT0FBTztLQUNSLENBQUMsQ0FBQztJQUVILE9BQU87UUFDTCxNQUFNO1FBRU4sSUFBSSxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sR0FBRyxFQUFFLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLEVBQUUsRUFBRSxFQUFFLE1BQU0sRUFBRSxDQUFDO1FBRXhFLFlBQVksRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFdBQVcsQ0FBQztRQUU5RCxTQUFTLEVBQUUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLEVBQUUsQ0FDNUIsTUFBTSxDQUFDLEdBQUcsQ0FBQyxTQUFTLE1BQU0sUUFBUSxFQUFFO1lBQ2xDLE1BQU0sb0JBQ0QsTUFBTSxJQUNULEdBQUcsRUFBRSxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FDMUI7U0FDRixDQUFDO1FBRUosVUFBVSxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxFQUFFLENBQzdCLE1BQU0sQ0FBQyxHQUFHLENBQUMsVUFBVSxNQUFNLEVBQUUsRUFBRTtZQUM3QixNQUFNLG9CQUNELE1BQU0sSUFDVCxHQUFHLEVBQUUsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQzFCO1NBQ0YsQ0FBQztRQUVKLGNBQWMsRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFNBQVMsQ0FBQztRQUU5RCxRQUFRLEVBQUUsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFNBQVMsTUFBTSxXQUFXLENBQUM7UUFFMUQsV0FBVyxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxFQUFFLENBQzlCLE1BQU0sQ0FBQyxJQUFJLENBQUMsU0FBUyxNQUFNLFdBQVcsRUFBRSxNQUFNLENBQUM7UUFFakQsYUFBYSxFQUFFLENBQUMsTUFBTSxFQUFFLFNBQVMsRUFBRSxFQUFFLENBQ25DLE1BQU0sQ0FBQyxNQUFNLENBQUMsU0FBUyxNQUFNLGFBQWEsU0FBUyxFQUFFLENBQUM7UUFFeEQsRUFBRSxFQUFFLEdBQUcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDO1FBRTFCLFlBQVksRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFdBQVcsQ0FBQztRQUU5RCxZQUFZLEVBQUUsU0FBUyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFlBQVksU0FBUyxRQUFRLENBQUM7UUFFcEUsY0FBYyxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sR0FBRyxFQUFFLEVBQUUsRUFBRSxDQUN0QyxNQUFNLENBQUMsR0FBRyxDQUFDLFNBQVMsTUFBTSxhQUFhLEVBQUUsRUFBRSxNQUFNLEVBQUUsQ0FBQztRQUV0RCxjQUFjLEVBQUUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLEVBQUUsRUFBRSxFQUFFLENBQ3RDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLGFBQWEsRUFBRSxFQUFFLE1BQU0sRUFBRSxDQUFDO1FBRXRELFNBQVMsRUFBRSxHQUFHLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsY0FBYyxHQUFHLEVBQUUsQ0FBQztRQUVqRCxVQUFVLEVBQUUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLEVBQUUsRUFBRSxFQUFFLENBQ2xDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxNQUFNLFNBQVMsRUFBRSxFQUFFLE1BQU0sRUFBRSxDQUFDO1FBRWxELFVBQVUsRUFBRSxDQUFDLE1BQU0sRUFBRSxNQUFNLEdBQUcsRUFBRSxFQUFFLEVBQUUsQ0FDbEMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxTQUFTLE1BQU0sU0FBUyxFQUFFLEVBQUUsTUFBTSxFQUFFLENBQUM7UUFFbEQsS0FBSyxFQUFFLEdBQUcsQ0FBQyxFQUFFLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxVQUFVLEdBQUcsRUFBRSxDQUFDO0tBQzFDLENBQUM7QUFDSixDQUFDLENBQUMifQ== |
@@ -43,2 +43,3 @@ export interface Global { | ||
export declare type EasingType = 'EASE_IN' /** Ease in with an animation curve similar to CSS ease-in */ | 'EASE_OUT' /** Ease out with an animation curve similar to CSS ease-out */ | 'EASE_IN_AND_OUT'; /** Ease in and then out with an animation curve similar to CSS ease-in-out */ | ||
export declare type RoleType = 'viewer' | 'editor' | 'owner'; | ||
export declare type NodeType = 'DOCUMENT' | 'CANVAS' | 'FRAME' | 'GROUP' | 'VECTOR' | 'BOOLEAN' | 'STAR' | 'LINE' | 'ELLIPSE' | 'REGULAR_POLYGON' | 'RECTANGLE' | 'TEXT' | 'SLICE' | 'COMPONENT' | 'INSTANCE'; | ||
@@ -605,12 +606,7 @@ export declare type Node = Document | Canvas | Frame | Group | Vector | BooleanGroup | Star | Line | Ellipse | RegularPolygon | Rectangle | Text | Slice | Component | Instance; | ||
} | ||
/** A relative offset within a frame */ | ||
export interface FrameOffset { | ||
/** Unique id specifying the frame */ | ||
readonly node_id: string; | ||
/** 2d vector offset within the frame */ | ||
readonly node_offset: Vector2; | ||
} | ||
interface SharedElement extends ComponentMetadata { | ||
/** The unique identifier of the figma file which contains the element */ | ||
readonly file_key: string; | ||
/** Id of the component node within the figma file */ | ||
readonly node_id: string; | ||
/** URL link to the element's thumbnail image */ | ||
@@ -688,2 +684,9 @@ readonly thumbnail_urlString: string; | ||
} | ||
/** A relative offset within a frame */ | ||
export interface FrameOffset { | ||
/** Unique id specifying the frame */ | ||
readonly node_id: string; | ||
/** 2d vector offset within the frame */ | ||
readonly node_offset: Vector2; | ||
} | ||
export interface ProjectSummary { | ||
@@ -703,2 +706,3 @@ readonly id: string; | ||
readonly name: string; | ||
readonly role: RoleType; | ||
readonly schemaVersion: number; | ||
@@ -723,2 +727,3 @@ readonly thumbnailUrl: string; | ||
readonly name: string; | ||
readonly role: RoleType; | ||
readonly thumbnailUrl: string; | ||
@@ -760,2 +765,15 @@ readonly version: string; | ||
} | ||
export interface ComponentResponse { | ||
readonly err: string | null; | ||
readonly status: number; | ||
readonly meta: { | ||
readonly [key: string]: FullComponentMetadata; | ||
}; | ||
} | ||
export interface StyleResponse { | ||
readonly err: string | null; | ||
readonly meta: { | ||
readonly [key: string]: FullStyleMetadata; | ||
}; | ||
} | ||
export interface FileSummary { | ||
@@ -768,5 +786,7 @@ readonly key: string; | ||
export interface TeamProjectsResponse { | ||
readonly name: string; | ||
readonly projects: ReadonlyArray<ProjectSummary>; | ||
} | ||
export interface ProjectFilesResponse { | ||
readonly name: string; | ||
readonly files: ReadonlyArray<FileSummary>; | ||
@@ -783,5 +803,11 @@ } | ||
} | ||
export interface FileComponentsResponse extends PaginationResponse { | ||
readonly components: ReadonlyArray<FullComponentMetadata>; | ||
} | ||
export interface TeamStylesResponse extends PaginationResponse { | ||
readonly styles: ReadonlyArray<FullStyleMetadata>; | ||
} | ||
export interface FileStylesResponse extends PaginationResponse { | ||
readonly styles: ReadonlyArray<FullStyleMetadata>; | ||
} | ||
export {}; |
@@ -63,3 +63,5 @@ import * as Figma from './figmaTypes'; | ||
/** The absolute canvas position of where to place the comment */ | ||
readonly client_meta: Figma.Vector2 | Figma.FrameOffset; | ||
readonly client_meta?: Figma.Vector2 | Figma.FrameOffset; | ||
/** The comment to reply to, if any. This must be a root comment, that is, you cannot reply to a comment that is a reply itself (a reply has a parent_id). */ | ||
readonly comment_id?: string; | ||
} | ||
@@ -155,3 +157,3 @@ export interface PaginationParams { | ||
* Posts a new comment on the file. | ||
* @param {fileId} String File to get comments from | ||
* @param {fileId} String File to post comment to | ||
* @param {params} PostCommentParams | ||
@@ -162,2 +164,9 @@ * @see https://www.figma.com/developers/api#post-comments-endpoint | ||
/** | ||
* Delete a comment from the file | ||
* @param {fileId} String File to delete comment from | ||
* @param {commentId} String id of the comment to be deleted | ||
* @see https://www.figma.com/developers/api#delete-comments-endpoint | ||
*/ | ||
readonly deleteComment: (fileId: string, commentId: string) => AxiosPromise<Figma.Comment>; | ||
/** | ||
* Get user information for the authenticated user. | ||
@@ -190,2 +199,8 @@ * @see https://www.figma.com/developers/api#get-me-endpoint | ||
/** | ||
* Get a paginated list of published components within a file | ||
* @param {fileId} String Id of the file to list components from | ||
* @see https://www.figma.com/developers/api#get-file-components-endpoint | ||
*/ | ||
readonly fileComponents: (fileId: string, params?: PaginationParams) => AxiosPromise<Figma.FileComponentsResponse>; | ||
/** | ||
* Get metadata on a component by key. | ||
@@ -195,6 +210,6 @@ * @param {key} The unique identifier of the component. | ||
*/ | ||
readonly component: (key: string) => AxiosPromise<Figma.FullComponentMetadata>; | ||
readonly component: (key: string) => AxiosPromise<Figma.ComponentResponse>; | ||
/** | ||
* Get a paginated list of published styles within a team library | ||
* @param {teamId} String Id of the team to list components from | ||
* @param {teamId} String Id of the team to list styles from | ||
* @see https://www.figma.com/developers/api#get-team-styles-endpoint | ||
@@ -204,2 +219,8 @@ */ | ||
/** | ||
* Get a paginated list of published styles within a file | ||
* @param {fileId} String Id of the file to list styles from | ||
* @see https://www.figma.com/developers/api#get-file-styles-endpoint | ||
*/ | ||
readonly fileStyles: (fileId: string, params?: PaginationParams) => AxiosPromise<Figma.FileStylesResponse>; | ||
/** | ||
* Get metadata on a style by key. | ||
@@ -209,4 +230,4 @@ * @param {key} The unique identifier of the style. | ||
*/ | ||
readonly style: (key: string) => AxiosPromise<Figma.FullStyleMetadata>; | ||
readonly style: (key: string) => AxiosPromise<Figma.StyleResponse>; | ||
} | ||
export declare const Client: (opts: ClientOptions) => ClientInterface; |
@@ -47,2 +47,5 @@ var __assign = (this && this.__assign) || function () { | ||
}, | ||
deleteComment: function (fileId, commentId) { | ||
return client.delete("files/" + fileId + "/comments/" + commentId); | ||
}, | ||
me: function () { return client.get("me"); }, | ||
@@ -55,2 +58,6 @@ teamProjects: function (teamId) { return client.get("teams/" + teamId + "/projects"); }, | ||
}, | ||
fileComponents: function (fileId, params) { | ||
if (params === void 0) { params = {}; } | ||
return client.get("files/" + fileId + "/components", { params: params }); | ||
}, | ||
component: function (key) { return client.get("components/" + key); }, | ||
@@ -61,5 +68,9 @@ teamStyles: function (teamId, params) { | ||
}, | ||
fileStyles: function (fileId, params) { | ||
if (params === void 0) { params = {}; } | ||
return client.get("files/" + fileId + "/styles", { params: params }); | ||
}, | ||
style: function (key) { return client.get("styles/" + key); } | ||
}; | ||
}; | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7QUFHQSxPQUFPLEtBQXNDLE1BQU0sT0FBTyxDQUFDO0FBOFAzRCxNQUFNLENBQUMsSUFBTSxNQUFNLEdBQUcsVUFBQyxJQUFtQjtJQUN4QyxJQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsV0FBVztRQUM5QixDQUFDLENBQUM7WUFDRSxhQUFhLEVBQUUsWUFBVSxJQUFJLENBQUMsV0FBYTtTQUM1QztRQUNILENBQUMsQ0FBQztZQUNFLGVBQWUsRUFBRSxJQUFJLENBQUMsbUJBQW1CO1NBQzFDLENBQUM7SUFFTixJQUFNLE1BQU0sR0FBRyxLQUFLLENBQUMsTUFBTSxDQUFDO1FBQzFCLE9BQU8sRUFBRSxjQUFXLElBQUksQ0FBQyxPQUFPLElBQUksZUFBZSxVQUFNO1FBQ3pELE9BQU8sU0FBQTtLQUNSLENBQUMsQ0FBQztJQUVILE9BQU87UUFDTCxNQUFNLFFBQUE7UUFFTixJQUFJLEVBQUUsVUFBQyxNQUFNLEVBQUUsTUFBVztZQUFYLHVCQUFBLEVBQUEsV0FBVztZQUFLLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQVEsRUFBRSxFQUFFLE1BQU0sUUFBQSxFQUFFLENBQUM7UUFBekMsQ0FBeUM7UUFFeEUsWUFBWSxFQUFFLFVBQUEsTUFBTSxJQUFJLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sY0FBVyxDQUFDLEVBQXRDLENBQXNDO1FBRTlELFNBQVMsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFNO1lBQ3hCLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sV0FBUSxFQUFFO2dCQUNsQyxNQUFNLGVBQ0QsTUFBTSxJQUNULEdBQUcsRUFBRSxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FDMUI7YUFDRixDQUFDO1FBTEYsQ0FLRTtRQUVKLFVBQVUsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFNO1lBQ3pCLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxZQUFVLE1BQVEsRUFBRTtnQkFDN0IsTUFBTSxlQUNELE1BQU0sSUFDVCxHQUFHLEVBQUUsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQzFCO2FBQ0YsQ0FBQztRQUxGLENBS0U7UUFFSixjQUFjLEVBQUUsVUFBQSxNQUFNLElBQUksT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLFdBQVMsTUFBTSxZQUFTLENBQUMsRUFBcEMsQ0FBb0M7UUFFOUQsUUFBUSxFQUFFLFVBQUEsTUFBTSxJQUFJLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sY0FBVyxDQUFDLEVBQXRDLENBQXNDO1FBRTFELFdBQVcsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFNO1lBQzFCLE9BQUEsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFTLE1BQU0sY0FBVyxFQUFFLE1BQU0sQ0FBQztRQUEvQyxDQUErQztRQUVqRCxFQUFFLEVBQUUsY0FBTSxPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQWhCLENBQWdCO1FBRTFCLFlBQVksRUFBRSxVQUFBLE1BQU0sSUFBSSxPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBUyxNQUFNLGNBQVcsQ0FBQyxFQUF0QyxDQUFzQztRQUU5RCxZQUFZLEVBQUUsVUFBQSxTQUFTLElBQUksT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLGNBQVksU0FBUyxXQUFRLENBQUMsRUFBekMsQ0FBeUM7UUFFcEUsY0FBYyxFQUFFLFVBQUMsTUFBTSxFQUFFLE1BQVc7WUFBWCx1QkFBQSxFQUFBLFdBQVc7WUFDbEMsT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLFdBQVMsTUFBTSxnQkFBYSxFQUFFLEVBQUUsTUFBTSxRQUFBLEVBQUUsQ0FBQztRQUFwRCxDQUFvRDtRQUV0RCxTQUFTLEVBQUUsVUFBQSxHQUFHLElBQUksT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLGdCQUFjLEdBQUssQ0FBQyxFQUEvQixDQUErQjtRQUVqRCxVQUFVLEVBQUUsVUFBQyxNQUFNLEVBQUUsTUFBVztZQUFYLHVCQUFBLEVBQUEsV0FBVztZQUM5QixPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBUyxNQUFNLFlBQVMsRUFBRSxFQUFFLE1BQU0sUUFBQSxFQUFFLENBQUM7UUFBaEQsQ0FBZ0Q7UUFFbEQsS0FBSyxFQUFFLFVBQUEsR0FBRyxJQUFJLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxZQUFVLEdBQUssQ0FBQyxFQUEzQixDQUEyQjtLQUMxQyxDQUFDO0FBQ0osQ0FBQyxDQUFDIn0= | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7QUFHQSxPQUFPLEtBQXNDLE1BQU0sT0FBTyxDQUFDO0FBOFIzRCxNQUFNLENBQUMsSUFBTSxNQUFNLEdBQUcsVUFBQyxJQUFtQjtJQUN4QyxJQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsV0FBVztRQUM5QixDQUFDLENBQUM7WUFDRSxhQUFhLEVBQUUsWUFBVSxJQUFJLENBQUMsV0FBYTtTQUM1QztRQUNILENBQUMsQ0FBQztZQUNFLGVBQWUsRUFBRSxJQUFJLENBQUMsbUJBQW1CO1NBQzFDLENBQUM7SUFFTixJQUFNLE1BQU0sR0FBRyxLQUFLLENBQUMsTUFBTSxDQUFDO1FBQzFCLE9BQU8sRUFBRSxjQUFXLElBQUksQ0FBQyxPQUFPLElBQUksZUFBZSxVQUFNO1FBQ3pELE9BQU8sU0FBQTtLQUNSLENBQUMsQ0FBQztJQUVILE9BQU87UUFDTCxNQUFNLFFBQUE7UUFFTixJQUFJLEVBQUUsVUFBQyxNQUFNLEVBQUUsTUFBVztZQUFYLHVCQUFBLEVBQUEsV0FBVztZQUFLLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQVEsRUFBRSxFQUFFLE1BQU0sUUFBQSxFQUFFLENBQUM7UUFBekMsQ0FBeUM7UUFFeEUsWUFBWSxFQUFFLFVBQUEsTUFBTSxJQUFJLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sY0FBVyxDQUFDLEVBQXRDLENBQXNDO1FBRTlELFNBQVMsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFNO1lBQ3hCLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sV0FBUSxFQUFFO2dCQUNsQyxNQUFNLGVBQ0QsTUFBTSxJQUNULEdBQUcsRUFBRSxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FDMUI7YUFDRixDQUFDO1FBTEYsQ0FLRTtRQUVKLFVBQVUsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFNO1lBQ3pCLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxZQUFVLE1BQVEsRUFBRTtnQkFDN0IsTUFBTSxlQUNELE1BQU0sSUFDVCxHQUFHLEVBQUUsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQzFCO2FBQ0YsQ0FBQztRQUxGLENBS0U7UUFFSixjQUFjLEVBQUUsVUFBQSxNQUFNLElBQUksT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLFdBQVMsTUFBTSxZQUFTLENBQUMsRUFBcEMsQ0FBb0M7UUFFOUQsUUFBUSxFQUFFLFVBQUEsTUFBTSxJQUFJLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sY0FBVyxDQUFDLEVBQXRDLENBQXNDO1FBRTFELFdBQVcsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFNO1lBQzFCLE9BQUEsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFTLE1BQU0sY0FBVyxFQUFFLE1BQU0sQ0FBQztRQUEvQyxDQUErQztRQUVqRCxhQUFhLEVBQUUsVUFBQyxNQUFNLEVBQUUsU0FBUztZQUMvQixPQUFBLE1BQU0sQ0FBQyxNQUFNLENBQUMsV0FBUyxNQUFNLGtCQUFhLFNBQVcsQ0FBQztRQUF0RCxDQUFzRDtRQUV4RCxFQUFFLEVBQUUsY0FBTSxPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQWhCLENBQWdCO1FBRTFCLFlBQVksRUFBRSxVQUFBLE1BQU0sSUFBSSxPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBUyxNQUFNLGNBQVcsQ0FBQyxFQUF0QyxDQUFzQztRQUU5RCxZQUFZLEVBQUUsVUFBQSxTQUFTLElBQUksT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLGNBQVksU0FBUyxXQUFRLENBQUMsRUFBekMsQ0FBeUM7UUFFcEUsY0FBYyxFQUFFLFVBQUMsTUFBTSxFQUFFLE1BQVc7WUFBWCx1QkFBQSxFQUFBLFdBQVc7WUFDbEMsT0FBQSxNQUFNLENBQUMsR0FBRyxDQUFDLFdBQVMsTUFBTSxnQkFBYSxFQUFFLEVBQUUsTUFBTSxRQUFBLEVBQUUsQ0FBQztRQUFwRCxDQUFvRDtRQUV0RCxjQUFjLEVBQUUsVUFBQyxNQUFNLEVBQUUsTUFBVztZQUFYLHVCQUFBLEVBQUEsV0FBVztZQUNsQyxPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBUyxNQUFNLGdCQUFhLEVBQUUsRUFBRSxNQUFNLFFBQUEsRUFBRSxDQUFDO1FBQXBELENBQW9EO1FBRXRELFNBQVMsRUFBRSxVQUFBLEdBQUcsSUFBSSxPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsZ0JBQWMsR0FBSyxDQUFDLEVBQS9CLENBQStCO1FBRWpELFVBQVUsRUFBRSxVQUFDLE1BQU0sRUFBRSxNQUFXO1lBQVgsdUJBQUEsRUFBQSxXQUFXO1lBQzlCLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxXQUFTLE1BQU0sWUFBUyxFQUFFLEVBQUUsTUFBTSxRQUFBLEVBQUUsQ0FBQztRQUFoRCxDQUFnRDtRQUVsRCxVQUFVLEVBQUUsVUFBQyxNQUFNLEVBQUUsTUFBVztZQUFYLHVCQUFBLEVBQUEsV0FBVztZQUM5QixPQUFBLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBUyxNQUFNLFlBQVMsRUFBRSxFQUFFLE1BQU0sUUFBQSxFQUFFLENBQUM7UUFBaEQsQ0FBZ0Q7UUFFbEQsS0FBSyxFQUFFLFVBQUEsR0FBRyxJQUFJLE9BQUEsTUFBTSxDQUFDLEdBQUcsQ0FBQyxZQUFVLEdBQUssQ0FBQyxFQUEzQixDQUEyQjtLQUMxQyxDQUFDO0FBQ0osQ0FBQyxDQUFDIn0= |
{ | ||
"name": "figma-js", | ||
"version": "1.8.5", | ||
"version": "1.9.0", | ||
"description": "A simple wrapper for the Figma API", | ||
@@ -5,0 +5,0 @@ "main": "build/main/index.js", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
104165
2235