Skip to content

fixed decorators to return a property descriptor to work with babel d… #206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/lib/decorators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ export type Constructor<T> = {
new (...args: unknown[]): T
};

export type FixedPropertyDecorator = (target: Object, propertyKey: string | symbol, descriptor?: BabelPropertyDescriptor) => any;
export interface BabelPropertyDescriptor extends PropertyDescriptor {
initializer: () => any;
}

/**
* Class decorator factory that defines the decorated class as a custom element.
*
Expand Down Expand Up @@ -55,9 +60,9 @@ export const customElement = (tagName: keyof HTMLElementTagNameMap) =>
* corresponding attribute value. A `PropertyDeclaration` may optionally be
* supplied to configure property features.
*/
export const property = (options?: PropertyDeclaration) => (proto: Object,
name: string) => {
(proto.constructor as typeof UpdatingElement).createProperty(name, options);
export const property = (options?: PropertyDeclaration): FixedPropertyDecorator => (proto: Object,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to satisfy typescript (temporarily) and be consistent with how other decorators are written, this should probably return any.

name: string | symbol, descriptor?: BabelPropertyDescriptor) => {
return (proto.constructor as typeof UpdatingElement).createProperty(name, options, descriptor);
};

/**
Expand Down
30 changes: 23 additions & 7 deletions src/lib/updating-element.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { BabelPropertyDescriptor } from './decorators';

/**
* @license
* Copyright (c) 2017 The Polymer Project Authors. All rights reserved.
Expand Down Expand Up @@ -172,7 +174,8 @@ export abstract class UpdatingElement extends HTMLElement {
*/
static createProperty(name: PropertyKey,
options:
PropertyDeclaration = defaultPropertyDeclaration) {
PropertyDeclaration = defaultPropertyDeclaration,
descriptor?: BabelPropertyDescriptor): PropertyDescriptor | null {
// ensure private storage for property declarations.
if (!this.hasOwnProperty('_classProperties')) {
this._classProperties = new Map();
Expand All @@ -187,19 +190,29 @@ export abstract class UpdatingElement extends HTMLElement {
// Allow user defined accessors by not replacing an existing own-property
// accessor.
if (this.prototype.hasOwnProperty(name)) {
return;
return null;
}

const key = typeof name === 'symbol' ? Symbol() : `__${name}`;
Object.defineProperty(this.prototype, name, {
get() { return this[key]; },
set(value) {

let defaultInitializer: null | (() => any) = descriptor ? descriptor!.initializer || null : null;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole handling of the default value seems just a little messy but i can see why...

The default value really needs to be in the constructor but babel annoyingly doesn't put it there...

return {
get(this: any) {
if (defaultInitializer) {
return defaultInitializer();
} else {
return this[key];
}
},
set(this: any, value) {
defaultInitializer = null;
const oldValue = this[name];
this[key] = value;
this._requestPropertyUpdate(name, oldValue, options);
},
configurable : true,
enumerable : true
});
};
}

/**
Expand Down Expand Up @@ -230,7 +243,10 @@ export abstract class UpdatingElement extends HTMLElement {
for (const p of propKeys) {
// note, use of `any` is due to TypeSript lack of support for symbol in
// index types
this.createProperty(p, (props as any)[p]);
const descriptor = this.createProperty(p, (props as any)[p]);
if (descriptor) {
Object.defineProperty(this.prototype, p, descriptor);
}
}
}

Expand Down