Skip to content

Commit 92aff24

Browse files
raininglemonsraininglemons
authored
Merge pull request #1 from raininglemons/lock-page
Lock page
2 parents aab4a20 + 3cd036f commit 92aff24

File tree

5 files changed

+341
-9
lines changed

5 files changed

+341
-9
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const aem = new AEM('http://localhost', 4502, 'admin', 'admin');
4040
const runner = function *() {
4141
const myNode = yield aem.createNode('/tmp/myNode');
4242

43-
yield myNode.activate;
43+
yield myNode.activate();
4444

4545
console.warn(`Created my node and activated it, yay, pub o'clock?`);
4646
}
@@ -53,8 +53,8 @@ remain "behind closed doors". You only want a node object to mess with or an err
5353
a lot more viable.~~
5454
1. Tests
5555
1. Economise on http requests where possible (Node#getProperties i'm looking at you...)
56-
1. Ability to lock and unlock nodes
56+
1. ~~Ability to lock and unlock nodes~~
5757

5858
## API
5959

60-
> HTML documentation can be [viewed here](https://cdn.rawgit.com/raininglemons/node-aem-api/3cae74082f172e62b5e70f5f0be94899038e4b8d/documentation/index.html)
60+
> HTML documentation can be [viewed here](https://cdn.rawgit.com/raininglemons/node-aem-api/lock-page/documentation/index.html)

‎documentation/index.html‎

Lines changed: 258 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html>
33
<head>
44
<meta charset='utf-8' />
5-
<title>aem-api 0.2.2 | Documentation</title>
5+
<title>aem-api 0.2.3 | Documentation</title>
66
<meta name='viewport' content='width=device-width,initial-scale=1'>
77
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
88
<link href='assets/style.css' type='text/css' rel='stylesheet' />
@@ -14,7 +14,7 @@
1414
<div class='fixed xs-hide fix-3 overflow-auto max-height-100'>
1515
<div class='py1 px2'>
1616
<h3 class='mb0 no-anchor'>aem-api</h3>
17-
<div class='mb1'><code>0.2.2</code></div>
17+
<div class='mb1'><code>0.2.3</code></div>
1818
<input
1919
placeholder='Filter'
2020
id='filter-input'
@@ -157,6 +157,18 @@ <h3 class='mb0 no-anchor'>aem-api</h3>
157157
#activateNode
158158
</a></li>
159159

160+
<li><a
161+
href='#AEM#lock'
162+
class='regular pre-open'>
163+
#lock
164+
</a></li>
165+
166+
<li><a
167+
href='#AEM#unlock'
168+
class='regular pre-open'>
169+
#unlock
170+
</a></li>
171+
160172
<li><a
161173
href='#AEM#deactivateNode'
162174
class='regular pre-open'>
@@ -316,6 +328,18 @@ <h3 class='mb0 no-anchor'>aem-api</h3>
316328
#deactivate
317329
</a></li>
318330

331+
<li><a
332+
href='#Node#lock'
333+
class='regular pre-open'>
334+
#lock
335+
</a></li>
336+
337+
<li><a
338+
href='#Node#unlock'
339+
class='regular pre-open'>
340+
#unlock
341+
</a></li>
342+
319343
</ul>
320344

321345

@@ -1868,6 +1892,134 @@ <h3 class='fl m0' id='aem'>
18681892

18691893

18701894

1895+
</section>
1896+
1897+
</div>
1898+
</div>
1899+
1900+
<div class='border-bottom' id='AEM#lock'>
1901+
<div class="clearfix small pointer toggle-sibling">
1902+
<div class="py1 contain">
1903+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
1904+
<span class='code strong strong truncate'>lock(path)</span>
1905+
</div>
1906+
</div>
1907+
<div class="clearfix display-none toggle-target">
1908+
<section class='p2 mb2 clearfix bg-white minishadow'>
1909+
1910+
1911+
1912+
<p>Locks a cq:Page</p>
1913+
1914+
1915+
<div class='pre p1 fill-light mt0'>lock(path: Any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</div>
1916+
1917+
1918+
1919+
1920+
1921+
1922+
1923+
1924+
1925+
1926+
<div class='py1 quiet mt1 prose-big'>Parameters</div>
1927+
<div class='prose'>
1928+
1929+
<div class='space-bottom0'>
1930+
<div>
1931+
<span class='code bold'>path</span> <code class='quiet'>(Any)</code>
1932+
</div>
1933+
1934+
</div>
1935+
1936+
</div>
1937+
1938+
1939+
1940+
1941+
1942+
1943+
<div class='py1 quiet mt1 prose-big'>Returns</div>
1944+
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</code>:
1945+
1946+
1947+
1948+
1949+
1950+
1951+
1952+
1953+
1954+
1955+
1956+
1957+
1958+
1959+
</section>
1960+
1961+
</div>
1962+
</div>
1963+
1964+
<div class='border-bottom' id='AEM#unlock'>
1965+
<div class="clearfix small pointer toggle-sibling">
1966+
<div class="py1 contain">
1967+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
1968+
<span class='code strong strong truncate'>unlock(path)</span>
1969+
</div>
1970+
</div>
1971+
<div class="clearfix display-none toggle-target">
1972+
<section class='p2 mb2 clearfix bg-white minishadow'>
1973+
1974+
1975+
1976+
<p>Unlocks a locked cq:Page</p>
1977+
1978+
1979+
<div class='pre p1 fill-light mt0'>unlock(path: Any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</div>
1980+
1981+
1982+
1983+
1984+
1985+
1986+
1987+
1988+
1989+
1990+
<div class='py1 quiet mt1 prose-big'>Parameters</div>
1991+
<div class='prose'>
1992+
1993+
<div class='space-bottom0'>
1994+
<div>
1995+
<span class='code bold'>path</span> <code class='quiet'>(Any)</code>
1996+
</div>
1997+
1998+
</div>
1999+
2000+
</div>
2001+
2002+
2003+
2004+
2005+
2006+
2007+
<div class='py1 quiet mt1 prose-big'>Returns</div>
2008+
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</code>:
2009+
2010+
2011+
2012+
2013+
2014+
2015+
2016+
2017+
2018+
2019+
2020+
2021+
2022+
18712023
</section>
18722024

18732025
</div>
@@ -3457,6 +3609,110 @@ <h3 class='fl m0' id='node'>
34573609

34583610

34593611

3612+
<div class='py1 quiet mt1 prose-big'>Returns</div>
3613+
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</code>:
3614+
3615+
3616+
3617+
3618+
3619+
3620+
3621+
3622+
3623+
3624+
3625+
3626+
3627+
3628+
</section>
3629+
3630+
</div>
3631+
</div>
3632+
3633+
<div class='border-bottom' id='Node#lock'>
3634+
<div class="clearfix small pointer toggle-sibling">
3635+
<div class="py1 contain">
3636+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
3637+
<span class='code strong strong truncate'>lock()</span>
3638+
</div>
3639+
</div>
3640+
<div class="clearfix display-none toggle-target">
3641+
<section class='p2 mb2 clearfix bg-white minishadow'>
3642+
3643+
3644+
3645+
<p>Locks an unlocked cq:Page</p>
3646+
3647+
3648+
<div class='pre p1 fill-light mt0'>lock(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</div>
3649+
3650+
3651+
3652+
3653+
3654+
3655+
3656+
3657+
3658+
3659+
3660+
3661+
3662+
3663+
3664+
<div class='py1 quiet mt1 prose-big'>Returns</div>
3665+
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</code>:
3666+
3667+
3668+
3669+
3670+
3671+
3672+
3673+
3674+
3675+
3676+
3677+
3678+
3679+
3680+
</section>
3681+
3682+
</div>
3683+
</div>
3684+
3685+
<div class='border-bottom' id='Node#unlock'>
3686+
<div class="clearfix small pointer toggle-sibling">
3687+
<div class="py1 contain">
3688+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
3689+
<span class='code strong strong truncate'>unlock()</span>
3690+
</div>
3691+
</div>
3692+
<div class="clearfix display-none toggle-target">
3693+
<section class='p2 mb2 clearfix bg-white minishadow'>
3694+
3695+
3696+
3697+
<p>Unlocks a locked cq:Page</p>
3698+
3699+
3700+
<div class='pre p1 fill-light mt0'>unlock(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</div>
3701+
3702+
3703+
3704+
3705+
3706+
3707+
3708+
3709+
3710+
3711+
3712+
3713+
3714+
3715+
34603716
<div class='py1 quiet mt1 prose-big'>Returns</div>
34613717
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling">Node</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>&gt;</code>:
34623718

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "aem-api",
3-
"version": "0.2.2",
3+
"version": "0.2.3",
44
"description": "API class to manipulate nodes within AEM from node.",
55
"main": "index.js",
66
"dependencies": {

0 commit comments

Comments
 (0)